java.lang.String requestId
java.lang.String errorCode
AmazonServiceException.ErrorType errorType
AmazonServiceException.ErrorTypejava.lang.String errorMessage
int statusCode
java.lang.String serviceName
java.lang.String activityId
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String description
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String cause
Constraints:
Length: 1 - 1023
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.util.Date startTime
java.util.Date endTime
java.lang.String statusCode
Constraints:
Allowed Values: WaitingForSpotInstanceRequestId, WaitingForSpotInstanceId, WaitingForInstanceId, PreInService, InProgress, WaitingForELBConnectionDraining, MidLifecycleAction, Successful, Failed, Cancelled
java.lang.String statusMessage
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer progress
java.lang.String details
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String adjustmentType
ChangeInCapacity, ExactCapacity, and
PercentChangeInCapacity. For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String alarmName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String alarmARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String autoScalingGroupARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer minSize
java.lang.Integer maxSize
java.lang.Integer desiredCapacity
java.lang.Integer defaultCooldown
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Constraints:
Length: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
java.lang.String healthCheckType
EC2 for Amazon EC2 or ELB for Elastic
Load Balancing.
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer healthCheckGracePeriod
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
java.util.Date createdTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> suspendedProcesses
java.lang.String placementGroup
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String vPCZoneIdentifier
If you
specify VPCZoneIdentifier and
AvailabilityZones, ensure that the Availability Zones of
the subnets match the values for AvailabilityZones.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> enabledMetrics
java.lang.String status
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> terminationPolicies
java.lang.String instanceId
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String availabilityZone
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String lifecycleState
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String healthStatus
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String virtualName
ephemeral0 to
ephemeral3.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String deviceName
/dev/sdh or xvdh).
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Ebs ebs
java.lang.Boolean noDevice
NoDevice is set to
true for the root device, the instance might fail the EC2
health check. Auto Scaling launches a replacement instance if the
instance fails the health check.java.lang.String lifecycleHookName
Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String lifecycleActionToken
Constraints:
Length: 36 - 36
java.lang.String lifecycleActionResult
CONTINUE or ABANDON.java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String launchConfigurationName
InstanceId parameter to specify an EC2 instance instead
of a launch configuration.
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String instanceId
LaunchConfigurationName
parameter to specify a launch configuration instead of an EC2
instance. When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.
For more information, see Create an Auto Scaling Group Using an EC2 Instance ID in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer minSize
java.lang.Integer maxSize
java.lang.Integer desiredCapacity
java.lang.Integer defaultCooldown
If
DefaultCooldown is not specified, the default value is
300. For more information, see Understanding
Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
VPCZoneIdentifier parameter.
Constraints:
Length: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
For more information, see Load Balance Your Auto Scaling Group in the Auto Scaling Developer Guide.
java.lang.String healthCheckType
EC2 and ELB. By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Checks.
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer healthCheckGracePeriod
This
parameter is required if you are adding an ELB health
check. Frequently, new instances need to warm up, briefly, before they
can pass a health check. To provide ample warm-up time, set the health
check grace period of the group to match the expected startup period
of your application.
For more information, see Add an Elastic Load Balancing Health Check to Your Auto Scaling Group in the Auto Scaling Developer Guide.
java.lang.String placementGroup
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String vPCZoneIdentifier
If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.
For more information, see Auto Scaling and Amazon VPC in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> terminationPolicies
For more information, see Choosing a Termination Policy for Your Auto Scaling Group in the Auto Scaling Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
For more information, see Add, Modify, or Remove Auto Scaling Group Tags in the Auto Scaling Developer Guide.
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String imageId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String keyName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information about security groups for EC2-Classic, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide.
If your instances are launched in a VPC, specify security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
java.lang.String userData
Constraints:
Length: 0 - 21847
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String instanceId
The new launch configuration derives attributes from the instance, with the exception of the block device mapping.
To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.
For more information, see Create a Launch Configuration Using an EC2 Instance in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String instanceType
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String kernelId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String ramdiskId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
InstanceMonitoring instanceMonitoring
When detailed monitoring is enabled, Amazon
Cloudwatch generates metrics every minute and your account is charged
a fee. When you disable detailed monitoring, by specifying
False, Cloudwatch generates metrics every 5 minutes. For
more information, see Monitor
Your Auto Scaling Instances in the Auto Scaling Developer
Guide.
java.lang.String spotPrice
Constraints:
Length: 1 - 255
java.lang.String iamInstanceProfile
Amazon EC2 instances launched with an IAM role will automatically have AWS security credentials available. You can use IAM roles with Auto Scaling to automatically enable applications running on your Amazon EC2 instances to securely access other AWS resources. For more information, see Launch Auto Scaling Instances with an IAM Role in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Boolean ebsOptimized
java.lang.Boolean associatePublicIpAddress
If you specify a value for this parameter, be sure to specify at least one subnet using the VPCZoneIdentifier parameter when you create your group.
Default: If the
instance is launched into a default subnet, the default is
true. If the instance is launched into a nondefault
subnet, the default is false. For more information, see
Supported
Platforms in the Amazon Elastic Compute Cloud User Guide.
java.lang.String placementTenancy
dedicated runs on single-tenant hardware and can only be
launched in a VPC. You must set the value of this parameter to
dedicated if want to launch Dedicated Instances in a
shared tenancy VPC (VPC with instance placement tenancy attribute set
to default).
If you specify a value for this parameter, be sure to specify at least one VPC subnet using the VPCZoneIdentifier parameter when you create your group.
For more information, see Auto Scaling and Amazon VPC in the Auto Scaling Developer Guide.
Valid values: default | dedicated
Constraints:
Length: 1 - 64
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
auto-scaling-group is the only supported resource type.
The valid value for the resource ID is groupname. The
PropagateAtLaunch flag defines whether the new tag will
be applied to instances launched by the group. Valid values are
true or false. However, instances that are
already running will not get the new or updated tag. Likewise, when
you modify a tag, the updated version will be applied only to new
instances launched by the group after the change. Running instances
that had the previous version of the tag will continue to have the
older tag.
When you create a tag and a tag of the same name already exists, the operation overwrites the previous tag definition, but you will not get an error message.
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Boolean forceDelete
java.lang.String lifecycleHookName
Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String topicARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String policyName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String scheduledActionName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.Integer maxNumberOfAutoScalingGroups
java.lang.Integer maxNumberOfLaunchConfigurations
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingGroupNames
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer maxRecords
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingGroups
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
java.lang.Integer maxRecords
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingInstances
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingNotificationTypes
autoscaling:EC2_INSTANCE_LAUNCH
autoscaling:EC2_INSTANCE_LAUNCH_ERROR
autoscaling:EC2_INSTANCE_TERMINATE
autoscaling:EC2_INSTANCE_TERMINATE_ERROR
autoscaling:TEST_NOTIFICATION
com.amazonaws.internal.ListWithAutoConstructFlag<T> launchConfigurationNames
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer maxRecords
com.amazonaws.internal.ListWithAutoConstructFlag<T> launchConfigurations
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> lifecycleHookNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> metrics
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
The GroupStandbyInstances metric is not
returned by default. You must explicitly request it when calling
EnableMetricsCollection.
com.amazonaws.internal.ListWithAutoConstructFlag<T> granularities
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingGroupNames
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer maxRecords
com.amazonaws.internal.ListWithAutoConstructFlag<T> notificationConfigurations
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer maxRecords
com.amazonaws.internal.ListWithAutoConstructFlag<T> scalingPolicies
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> activityIds
AutoScalingGroupName is provided, the results are limited
to that group. The list of requested activities cannot contain more
than 50 items. If unknown activities are requested, they are ignored
with no error.java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer maxRecords
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> activities
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> scheduledActionNames
You can describe up
to a maximum of 50 instances with a single call. If there are more
items to return, the call returns a token. To get the next set of
items, repeat the call with the returned token in the
NextToken parameter.
java.util.Date startTime
java.util.Date endTime
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer maxRecords
com.amazonaws.internal.ListWithAutoConstructFlag<T> scheduledUpdateGroupActions
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer maxRecords
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String nextToken
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Boolean shouldDecrementDesiredCapacity
True, the Auto Scaling group decrements the desired
capacity value by the number of instances detached.java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> metrics
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
If you omit this parameter, all metrics are disabled.
java.lang.String snapshotId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer volumeSize
Valid values: If the volume type is
io1, the minimum size of the volume is 10 GiB. If you
specify SnapshotId and VolumeSize,
VolumeSize must be equal to or larger than the size of
the snapshot.
Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the size of the snapshot.
Required: Required when the volume type is
io1.
Constraints:
Range: 1 - 1024
java.lang.String volumeType
Valid values: standard | io1 | gp2
Default: standard
Constraints:
Length: 1 - 255
java.lang.Boolean deleteOnTermination
Default: true
java.lang.Integer iops
Valid values: Range is 100 to 4000.
Default: None
Constraints:
Range: 100 - 4000
java.lang.String metric
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String granularity
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> metrics
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
If you omit this parameter, all metrics are enabled. The GroupStandbyInstances metric is not returned by
default. You must explicitly request it when calling
EnableMetricsCollection.
java.lang.String granularity
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Standby mode. You must
specify at least one instance ID.java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Boolean shouldDecrementDesiredCapacity
Standby mode
count as part of the Auto Scaling group's desired capacity. If set,
the desired capacity for the Auto Scaling group decrements by the
number of instances moved to Standby mode.java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String policyName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Boolean honorCooldown
True if you want Auto Scaling to wait for the
cooldown period associated with the Auto Scaling group to complete
before executing the policy. Set to False if you want
Auto Scaling to circumvent the cooldown period associated with the
Auto Scaling group and execute the policy before the cooldown period
ends.
For more information, see Understanding Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String name
"auto-scaling-group", "key",
"value", and "propagate-at-launch".
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
java.lang.String instanceId
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String availabilityZone
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String lifecycleState
The
Quarantined lifecycle state is not used.
Constraints:
Allowed Values: Pending, Pending:Wait, Pending:Proceed, Quarantined, InService, Terminating, Terminating:Wait, Terminating:Proceed, Terminated, Detaching, Detached, EnteringStandby, Standby
java.lang.String healthStatus
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String launchConfigurationARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String imageId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String keyName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
java.lang.String userData
Constraints:
Length: 0 - 21847
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String instanceType
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String kernelId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String ramdiskId
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
virtualName
and a deviceName.InstanceMonitoring instanceMonitoring
java.lang.String spotPrice
Constraints:
Length: 1 - 255
java.lang.String iamInstanceProfile
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.util.Date createdTime
java.lang.Boolean ebsOptimized
true) or not (false).java.lang.Boolean associatePublicIpAddress
true) or not (false).java.lang.String placementTenancy
default or
dedicated. An instance with dedicated
tenancy runs in an isolated, single-tenant hardware and can only be
launched in a VPC.
Constraints:
Length: 1 - 64
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String lifecycleHookName
Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String lifecycleTransition
java.lang.String notificationTargetARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String roleARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String notificationMetadata
Constraints:
Length: 1 - 1023
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer heartbeatTimeout
DefaultResult parameter. You can
prevent the lifecycle hook from timing out by calling
RecordLifecycleActionHeartbeat.java.lang.Integer globalTimeout
Pending:Wait or Terminating:Wait state.
Currently, this value is set at 48 hours.java.lang.String defaultResult
CONTINUE and ABANDON. The
default value is CONTINUE.java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String topicARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String notificationType
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String lifecycleHookName
Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String lifecycleTransition
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
java.lang.String roleARN
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String notificationTargetARN
This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
The notification message sent to the target will include:
This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.
When you call this operation,
a test message is sent to the notification target. This test message
contains an additional key/value pair:
Event:autoscaling:TEST_NOTIFICATION.
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String notificationMetadata
Constraints:
Length: 1 - 1023
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer heartbeatTimeout
DefaultResult
parameter. You can prevent the lifecycle hook from timing out by
calling RecordLifecycleActionHeartbeat. The default value for
this parameter is 3600 seconds (1 hour).java.lang.String defaultResult
CONTINUE or
ABANDON. The default value for this parameter is
ABANDON.java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String topicARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> notificationTypes
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String policyName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer scalingAdjustment
AdjustmentType
determines the interpretation of this number (e.g., as an absolute
number or as a percentage of the existing Auto Scaling group size). A
positive increment adds to the current capacity and a negative value
removes from the current capacity.java.lang.String adjustmentType
ScalingAdjustment is an absolute
number or a percentage of the current capacity. Valid values are
ChangeInCapacity, ExactCapacity, and
PercentChangeInCapacity. For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer cooldown
For more information, see Understanding Auto Scaling Cooldowns in the Auto Scaling Developer Guide.
java.lang.Integer minAdjustmentStep
AdjustmentType with the value
PercentChangeInCapacity, the scaling policy changes the
DesiredCapacity of the Auto Scaling group by at least the
number of instances specified in the value. You will get a
ValidationError if you use MinAdjustmentStep
on a policy with an AdjustmentType other than
PercentChangeInCapacity.
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String scheduledActionName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.util.Date time
Time is deprecated. The time for this action to start.
Time is an alias for StartTime and can be
specified instead of StartTime, or vice versa. If both
Time and StartTime are specified, their
values should be identical. Otherwise,
PutScheduledUpdateGroupAction will return an error.
java.util.Date startTime
--start-time
2010-06-01T00:00:00Z. If you try to schedule your action in the past, Auto Scaling returns an error message.
When
StartTime and EndTime are specified with
Recurrence, they form the boundaries of when the
recurring action will start and stop.
java.util.Date endTime
java.lang.String recurrence
When StartTime and
EndTime are specified with Recurrence, they
form the boundaries of when the recurring action will start and stop.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer minSize
java.lang.Integer maxSize
java.lang.Integer desiredCapacity
java.lang.String lifecycleHookName
Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String lifecycleActionToken
Constraints:
Length: 36 - 36
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> scalingProcesses
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String policyName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer scalingAdjustment
java.lang.String adjustmentType
ScalingAdjustment is an absolute
number or a percentage of the current capacity. Valid values are
ChangeInCapacity, ExactCapacity, and
PercentChangeInCapacity.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer cooldown
java.lang.String policyARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarms
java.lang.Integer minAdjustmentStep
DesiredCapacity of the Auto Scaling group by
at least the specified number of instances.java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String scheduledActionName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String scheduledActionARN
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.util.Date time
Time is deprecated. The time that the action is
scheduled to begin. Time is an alias for
StartTime.
java.util.Date startTime
When StartTime and
EndTime are specified with Recurrence, they
form the boundaries of when the recurring action will start and stop.
java.util.Date endTime
java.lang.String recurrence
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer minSize
java.lang.Integer maxSize
java.lang.Integer desiredCapacity
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer desiredCapacity
java.lang.Boolean honorCooldown
SetDesiredCapacity overrides any cooldown
period associated with the Auto Scaling group. Specify
True to make Auto Scaling to wait for the cool-down
period associated with the Auto Scaling group to complete before
initiating a scaling activity to set your Auto Scaling group to its
new capacity.java.lang.String instanceId
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String healthStatus
Healthy if you
want the instance to remain in service. Set to Unhealthy
if you want the instance to be out of service. Auto Scaling will
terminate and replace the unhealthy instance.
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Boolean shouldRespectGracePeriod
HealthCheckGracePeriod specified for the group, by
default, this call will respect the grace period. Set this to
False, if you do not want the call to respect the grace
period associated with the group. For more information, see the
HealthCheckGracePeriod parameter description for
CreateAutoScalingGroup.
java.lang.String processName
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String suspensionReason
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> scalingProcesses
java.lang.String resourceId
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String resourceType
auto-scaling-group resource type.
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String key
Constraints:
Length: 1 - 128
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String value
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Boolean propagateAtLaunch
java.lang.String resourceId
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String resourceType
auto-scaling-group resource type.
Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String key
Constraints:
Length: 1 - 128
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String value
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Boolean propagateAtLaunch
java.lang.String instanceId
Constraints:
Length: 1 - 16
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Boolean shouldDecrementDesiredCapacity
true, terminating this instance also decrements the
size of the Auto Scaling group.Activity activity
java.lang.String autoScalingGroupName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String launchConfigurationName
Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer minSize
java.lang.Integer maxSize
java.lang.Integer desiredCapacity
java.lang.Integer defaultCooldown
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Constraints:
Length: 1 -
java.lang.String healthCheckType
EC2 for Amazon EC2 or
ELB for Elastic Load Balancing.
Constraints:
Length: 1 - 32
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer healthCheckGracePeriod
java.lang.String placementGroup
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String vPCZoneIdentifier
When
you specify VPCZoneIdentifier with
AvailabilityZones, ensure that the subnets' Availability
Zones match the values you specify for AvailabilityZones.
For more information, see Auto Scaling and Amazon VPC in the Auto Scaling Developer Guide.
Constraints:
Length: 1 - 255
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> terminationPolicies
For more information, see Choosing a Termination Policy for Your Auto Scaling Group in the Auto Scaling Developer Guide.
java.lang.String stackName
java.lang.String templateBody
Conditional: You
must specify either the TemplateBody or the
TemplateURL parameter, but not both.
Constraints:
Length: 1 -
java.lang.String templateURL
Conditional: You
must specify either the TemplateBody or the
TemplateURL parameter, but not both.
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Parameter structures that specify input
parameters for the stack.java.lang.Boolean disableRollback
true to disable rollback of the stack if stack
creation failed. You can specify either DisableRollback
or OnFailure, but not both. Default:
false
java.lang.Integer timeoutInMinutes
DisableRollback is not set or is set to
false, the stack will be rolled back.
Constraints:
Range: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> notificationARNs
Constraints:
Length: 0 - 5
com.amazonaws.internal.ListWithAutoConstructFlag<T> capabilities
Currently, the only valid value is
CAPABILITY_IAM, which is required for the following
resources:
AWS::CloudFormation::Stack,
AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy,
AWS::IAM::Role,
AWS::IAM::User, and
AWS::IAM::UserToGroupAddition. If your stack template contains
these resources, we recommend that you review any permissions
associated with them. If you don't specify this parameter, this action
returns an InsufficientCapabilities error.
java.lang.String onFailure
OnFailure or DisableRollback, but not
both. Default: ROLLBACK
Constraints:
Allowed Values: DO_NOTHING, ROLLBACK, DELETE
java.lang.String stackPolicyBody
StackPolicyBody or the
StackPolicyURL parameter, but not both.
Constraints:
Length: 1 - 16384
java.lang.String stackPolicyURL
StackPolicyBody
or the StackPolicyURL parameter, but not both.
Constraints:
Length: 1 - 1350
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Tags to associate with this stack,
represented by key/value pairs. Tags defined for the stack are
propagated to EC2 resources that are created as part of the stack. A
maximum number of 10 tags can be specified.java.lang.String stackName
Default: There is no default value.
java.lang.String nextToken
Default: There is no default value.
Constraints:
Length: 1 - 1024
java.lang.String stackName
Default: There is no default value.
java.lang.String logicalResourceId
Default: There is no default value.
StackResourceDetail stackResourceDetail
StackResourceDetail structure containing the
description of the specified resource in the specified stack.java.lang.String stackName
Default: There is no default value.
Required: Conditional. If you do not
specify StackName, you must specify
PhysicalResourceId.
java.lang.String logicalResourceId
Default: There is no default value.
java.lang.String physicalResourceId
For example, for
an Amazon Elastic Compute Cloud (EC2) instance,
PhysicalResourceId corresponds to the
InstanceId. You can pass the EC2 InstanceId
to DescribeStackResources to find which stack the
instance belongs to and what other resources are part of the stack.
Required: Conditional. If you do not specify
PhysicalResourceId, you must specify
StackName.
Default: There is no default value.
java.lang.String stackName
Default: There is no default value.
java.lang.String nextToken
Constraints:
Length: 1 - 1024
java.lang.String templateBody
Conditional: You
must pass TemplateBody or TemplateURL. If
both are passed, only TemplateBody is used.
Constraints:
Length: 1 -
java.lang.String templateURL
Conditional: You
must pass TemplateURL or TemplateBody. If
both are passed, only TemplateBody is used.
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Parameter structures that specify input
parameters.java.lang.String stackPolicyBody
Constraints:
Length: 1 - 16384
java.lang.String stackName
Default: There is no default value.
java.lang.String templateBody
Constraints:
Length: 1 -
java.lang.String templateBody
Conditional: You
must specify only one of the following parameters:
StackName, TemplateBody, or
TemplateURL.
Constraints:
Length: 1 -
java.lang.String templateURL
Conditional: You
must specify only one of the following parameters:
StackName, TemplateBody, or
TemplateURL.
Constraints:
Length: 1 - 1024
java.lang.String stackName
Conditional: You must specify only one
of the following parameters: StackName,
TemplateBody, or TemplateURL.
Constraints:
Length: 1 -
Pattern: ([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
java.lang.String description
Description property of
the template.com.amazonaws.internal.ListWithAutoConstructFlag<T> capabilities
java.lang.String capabilitiesReason
java.lang.String version
java.lang.String stackName
Default: There is no default value.
java.lang.String nextToken
Default: There is no default value.
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> stackResourceSummaries
StackResourceSummary structures.java.lang.String nextToken
Constraints:
Length: 1 - 1024
java.lang.String nextToken
Default: There is no default value.
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> stackStatusFilters
StackStatus
parameter of the Stack data type.com.amazonaws.internal.ListWithAutoConstructFlag<T> stackSummaries
StackSummary structures containing information
about the specified stacks.java.lang.String nextToken
Constraints:
Length: 1 - 1024
java.lang.String parameterKey
java.lang.String parameterValue
java.lang.Boolean usePreviousValue
java.lang.String parameterKey
java.lang.String defaultValue
java.lang.String parameterType
java.lang.Boolean noEcho
java.lang.String description
java.lang.String stackName
java.lang.String stackPolicyBody
StackPolicyBody or the
StackPolicyURL parameter, but not both.
Constraints:
Length: 1 - 16384
java.lang.String stackPolicyURL
StackPolicyBody
or the StackPolicyURL parameter, but not both.
Constraints:
Length: 1 - 1350
java.lang.String stackName
Constraints:
Length: 1 -
Pattern: ([a-zA-Z][-a-zA-Z0-9]*)|(arn:\b(aws|aws-us-gov|aws-cn)\b:[-a-zA-Z0-9:/._+]*)
java.lang.String logicalResourceId
java.lang.String uniqueId
Constraints:
Length: 1 - 64
java.lang.String status
Constraints:
Allowed Values: SUCCESS, FAILURE
java.lang.String stackId
java.lang.String stackName
java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Parameter structures.java.util.Date creationTime
java.util.Date lastUpdatedTime
java.lang.String stackStatus
Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE
java.lang.String stackStatusReason
java.lang.Boolean disableRollback
true: disable rollbackfalse: enable rollbackcom.amazonaws.internal.ListWithAutoConstructFlag<T> notificationARNs
Constraints:
Length: 0 - 5
java.lang.Integer timeoutInMinutes
Constraints:
Range: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> capabilities
com.amazonaws.internal.ListWithAutoConstructFlag<T> outputs
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Tags that specify cost allocation information
for the stack.java.lang.String stackId
java.lang.String eventId
java.lang.String stackName
java.lang.String logicalResourceId
java.lang.String physicalResourceId
java.lang.String resourceType
java.util.Date timestamp
java.lang.String resourceStatus
Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, DELETE_SKIPPED, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE
java.lang.String resourceStatusReason
java.lang.String resourceProperties
java.lang.String stackName
java.lang.String stackId
java.lang.String logicalResourceId
java.lang.String physicalResourceId
java.lang.String resourceType
java.util.Date timestamp
java.lang.String resourceStatus
Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, DELETE_SKIPPED, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE
java.lang.String resourceStatusReason
java.lang.String description
java.lang.String stackName
java.lang.String stackId
java.lang.String logicalResourceId
java.lang.String physicalResourceId
java.lang.String resourceType
java.util.Date lastUpdatedTimestamp
java.lang.String resourceStatus
Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, DELETE_SKIPPED, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE
java.lang.String resourceStatusReason
java.lang.String description
java.lang.String metadata
Metadata attribute
declared for the resource. For more information, see Metadata
Attribute in the AWS CloudFormation User Guide.java.lang.String logicalResourceId
java.lang.String physicalResourceId
java.lang.String resourceType
java.util.Date lastUpdatedTimestamp
java.lang.String resourceStatus
Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, DELETE_SKIPPED, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE
java.lang.String resourceStatusReason
java.lang.String stackId
java.lang.String stackName
java.lang.String templateDescription
java.util.Date creationTime
java.util.Date lastUpdatedTime
java.util.Date deletionTime
java.lang.String stackStatus
Constraints:
Allowed Values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE
java.lang.String stackStatusReason
java.lang.String key
aws:.java.lang.String value
java.lang.String parameterKey
java.lang.String defaultValue
java.lang.Boolean noEcho
java.lang.String description
java.lang.String stackName
java.lang.String templateBody
Conditional: You
must specify either the TemplateBody or the
TemplateURL parameter, but not both.
Constraints:
Length: 1 -
java.lang.String templateURL
Conditional: You
must specify either the TemplateBody or the
TemplateURL parameter, but not both.
Constraints:
Length: 1 - 1024
java.lang.Boolean usePreviousTemplate
java.lang.String stackPolicyDuringUpdateBody
StackPolicyDuringUpdateBody or the
StackPolicyDuringUpdateURL parameter, but not both. If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
Constraints:
Length: 1 - 16384
java.lang.String stackPolicyDuringUpdateURL
StackPolicyDuringUpdateBody or the
StackPolicyDuringUpdateURL parameter, but not both. If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
Constraints:
Length: 1 - 1350
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Parameter structures that specify input
parameters for the stack.com.amazonaws.internal.ListWithAutoConstructFlag<T> capabilities
CAPABILITY_IAM, which is required for the following
resources:
AWS::CloudFormation::Stack,
AWS::IAM::AccessKey,
AWS::IAM::Group,
AWS::IAM::InstanceProfile,
AWS::IAM::Policy,
AWS::IAM::Role,
AWS::IAM::User, and
AWS::IAM::UserToGroupAddition. If your stack template contains
these resources, we recommend that you review any permissions
associated with them. If you don't specify this parameter, this action
returns an InsufficientCapabilities error.java.lang.String stackPolicyBody
StackPolicyBody or the StackPolicyURL
parameter, but not both. You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
Constraints:
Length: 1 - 16384
java.lang.String stackPolicyURL
StackPolicyBody or the StackPolicyURL
parameter, but not both. You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
Constraints:
Length: 1 - 1350
com.amazonaws.internal.ListWithAutoConstructFlag<T> notificationARNs
Constraints:
Length: 0 - 5
java.lang.String templateBody
Conditional: You
must pass TemplateURL or TemplateBody. If
both are passed, only TemplateBody is used.
Constraints:
Length: 1 -
java.lang.String templateURL
Conditional: You
must pass TemplateURL or TemplateBody. If
both are passed, only TemplateBody is used.
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
TemplateParameter structures.java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> capabilities
java.lang.String capabilitiesReason
java.lang.Boolean enabled
java.lang.Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
java.lang.Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
CachedMethods cachedMethods
java.lang.String pathPattern
java.lang.String targetOriginId
ForwardedValues forwardedValues
TrustedSigners trustedSigners
java.lang.String viewerProtocolPolicy
Constraints:
Allowed Values: allow-all, https-only, redirect-to-https
java.lang.Long minTTL
AllowedMethods allowedMethods
java.lang.Boolean smoothStreaming
java.lang.Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
java.lang.String id
java.lang.String s3CanonicalUserId
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
java.lang.String callerReference
java.lang.String comment
java.lang.String marker
java.lang.String nextMarker
java.lang.Integer maxItems
java.lang.Boolean isTruncated
java.lang.Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
java.lang.String id
java.lang.String s3CanonicalUserId
java.lang.String comment
java.lang.String forward
Constraints:
Allowed Values: none, whitelist, all
CookieNames whitelistedNames
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity
java.lang.String location
java.lang.String eTag
DistributionConfig distributionConfig
Distribution distribution
java.lang.String location
java.lang.String eTag
java.lang.String distributionId
InvalidationBatch invalidationBatch
java.lang.String location
Invalidation invalidation
StreamingDistributionConfig streamingDistributionConfig
StreamingDistribution streamingDistribution
java.lang.String location
java.lang.String eTag
java.lang.Integer errorCode
java.lang.String responsePagePath
java.lang.String responseCode
java.lang.Long errorCachingMinTTL
java.lang.Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
java.lang.Integer hTTPPort
java.lang.Integer hTTPSPort
java.lang.String originProtocolPolicy
Constraints:
Allowed Values: http-only, match-viewer
java.lang.String targetOriginId
ForwardedValues forwardedValues
TrustedSigners trustedSigners
java.lang.String viewerProtocolPolicy
Constraints:
Allowed Values: allow-all, https-only, redirect-to-https
java.lang.Long minTTL
AllowedMethods allowedMethods
java.lang.Boolean smoothStreaming
java.lang.String id
java.lang.String status
java.util.Date lastModifiedTime
java.lang.Integer inProgressInvalidationBatches
java.lang.String domainName
ActiveTrustedSigners activeTrustedSigners
DistributionConfig distributionConfig
java.lang.String callerReference
Aliases aliases
java.lang.String defaultRootObject
Origins origins
DefaultCacheBehavior defaultCacheBehavior
CacheBehaviors cacheBehaviors
CustomErrorResponses customErrorResponses
java.lang.String comment
LoggingConfig logging
java.lang.String priceClass
Constraints:
Allowed Values: PriceClass_100, PriceClass_200, PriceClass_All
java.lang.Boolean enabled
ViewerCertificate viewerCertificate
Restrictions restrictions
java.lang.String marker
java.lang.String nextMarker
java.lang.Integer maxItems
java.lang.Boolean isTruncated
java.lang.Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
java.lang.String id
java.lang.String status
java.util.Date lastModifiedTime
java.lang.String domainName
Aliases aliases
Origins origins
DefaultCacheBehavior defaultCacheBehavior
CacheBehaviors cacheBehaviors
CustomErrorResponses customErrorResponses
java.lang.String comment
java.lang.String priceClass
java.lang.Boolean enabled
ViewerCertificate viewerCertificate
Restrictions restrictions
java.lang.Boolean queryString
CookiePreference cookies
Headers headers
java.lang.String restrictionType
Constraints:
Allowed Values: blacklist, whitelist, none
java.lang.Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
java.lang.String eTag
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity
java.lang.String eTag
DistributionConfig distributionConfig
java.lang.String eTag
Distribution distribution
java.lang.String eTag
Invalidation invalidation
StreamingDistributionConfig streamingDistributionConfig
java.lang.String eTag
StreamingDistribution streamingDistribution
java.lang.String eTag
java.lang.Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
java.lang.String id
java.lang.String status
java.util.Date createTime
InvalidationBatch invalidationBatch
Paths paths
java.lang.String callerReference
java.lang.String marker
java.lang.String nextMarker
java.lang.Integer maxItems
java.lang.Boolean isTruncated
java.lang.Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
java.lang.String marker
java.lang.String maxItems
CloudFrontOriginAccessIdentityList cloudFrontOriginAccessIdentityList
java.lang.String marker
java.lang.String maxItems
DistributionList distributionList
java.lang.String distributionId
java.lang.String marker
java.lang.String maxItems
InvalidationList invalidationList
java.lang.String marker
java.lang.String maxItems
StreamingDistributionList streamingDistributionList
java.lang.Boolean enabled
java.lang.Boolean includeCookies
java.lang.String bucket
java.lang.String prefix
java.lang.String id
java.lang.String domainName
S3OriginConfig s3OriginConfig
CustomOriginConfig customOriginConfig
GeoRestriction geoRestriction
java.lang.String originAccessIdentity
java.lang.String awsAccountNumber
KeyPairIds keyPairIds
java.lang.String id
java.lang.String status
java.util.Date lastModifiedTime
java.lang.String domainName
ActiveTrustedSigners activeTrustedSigners
StreamingDistributionConfig streamingDistributionConfig
java.lang.String callerReference
S3Origin s3Origin
Aliases aliases
java.lang.String comment
StreamingLoggingConfig logging
TrustedSigners trustedSigners
java.lang.String priceClass
Constraints:
Allowed Values: PriceClass_100, PriceClass_200, PriceClass_All
java.lang.Boolean enabled
java.lang.String marker
java.lang.String nextMarker
java.lang.Integer maxItems
java.lang.Boolean isTruncated
java.lang.Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
java.lang.String id
java.lang.String status
java.util.Date lastModifiedTime
java.lang.String domainName
S3Origin s3Origin
Aliases aliases
TrustedSigners trustedSigners
java.lang.String comment
java.lang.String priceClass
java.lang.Boolean enabled
java.lang.Boolean enabled
java.lang.String bucket
java.lang.String prefix
java.lang.Boolean enabled
java.lang.Integer quantity
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
java.lang.String id
java.lang.String ifMatch
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity
java.lang.String eTag
DistributionConfig distributionConfig
java.lang.String id
java.lang.String ifMatch
Distribution distribution
java.lang.String eTag
StreamingDistributionConfig streamingDistributionConfig
java.lang.String id
java.lang.String ifMatch
StreamingDistribution streamingDistribution
java.lang.String eTag
java.lang.String iAMCertificateId
java.lang.Boolean cloudFrontDefaultCertificate
java.lang.String sSLSupportMethod
Constraints:
Allowed Values: sni-only, vip
java.lang.String minimumProtocolVersion
Constraints:
Allowed Values: SSLv3, TLSv1
java.lang.String subnetId
Constraints:
Pattern: subnet-[0-9a-f]{8}
java.lang.String sshKey
Constraints:
Pattern: [a-zA-Z0-9+/= ._:\\@-]*
java.lang.String eniIp
Constraints:
Pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}
java.lang.String iamRoleArn
Constraints:
Pattern: arn:aws(-iso)?:iam::[0-9]{12}:role/[a-zA-Z0-9_\+=,\.\-@]{1,64}
java.lang.String externalId
Constraints:
Pattern: [\w :+=./-]*
java.lang.String subscriptionType
Constraints:
Allowed Values: PRODUCTION
java.lang.String clientToken
Constraints:
Pattern: [a-zA-Z0-9]{1,64}
java.lang.String syslogIp
Constraints:
Pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}
java.lang.String label
Constraints:
Pattern: [a-zA-Z0-9_.-]{2,64}
java.lang.String certificate
Constraints:
Length: 600 - 2400
Pattern: [\w :+=./\n-]*
java.lang.String hapgArn
Constraints:
Pattern: arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\-]*:[0-9]{12}:hapg-[0-9a-f]{8}
java.lang.String hapgSerial
Constraints:
Pattern: [\w :+=./\\-]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> hsmsLastActionFailed
com.amazonaws.internal.ListWithAutoConstructFlag<T> hsmsPendingDeletion
com.amazonaws.internal.ListWithAutoConstructFlag<T> hsmsPendingRegistration
java.lang.String label
Constraints:
Pattern: [a-zA-Z0-9_.-]{1,64}
java.lang.String lastModifiedTimestamp
Constraints:
Pattern: \d*
com.amazonaws.internal.ListWithAutoConstructFlag<T> partitionSerialList
java.lang.String state
Constraints:
Allowed Values: READY, UPDATING, DEGRADED
java.lang.String hsmArn
Constraints:
Pattern: arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\-]*:[0-9]{12}:hsm-[0-9a-f]{8}
java.lang.String hsmSerialNumber
Constraints:
Pattern: \d{1,16}
java.lang.String hsmArn
Constraints:
Pattern: arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\-]*:[0-9]{12}:hsm-[0-9a-f]{8}
java.lang.String status
Constraints:
Allowed Values: PENDING, RUNNING, UPDATING, SUSPENDED, TERMINATING, TERMINATED, DEGRADED
java.lang.String statusDetails
Constraints:
Pattern: [\w :+=./\\-]*
java.lang.String availabilityZone
Constraints:
Pattern: [a-zA-Z0-9\-]*
java.lang.String eniId
Constraints:
Pattern: eni-[0-9a-f]{8}
java.lang.String eniIp
Constraints:
Pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}
java.lang.String subscriptionType
Constraints:
Allowed Values: PRODUCTION
java.lang.String subscriptionStartDate
Constraints:
Pattern: \d*
java.lang.String subscriptionEndDate
Constraints:
Pattern: \d*
java.lang.String vpcId
Constraints:
Pattern: vpc-[0-9a-f]{8}
java.lang.String subnetId
Constraints:
Pattern: subnet-[0-9a-f]{8}
java.lang.String iamRoleArn
Constraints:
Pattern: arn:aws(-iso)?:iam::[0-9]{12}:role/[a-zA-Z0-9_\+=,\.\-@]{1,64}
java.lang.String serialNumber
Constraints:
Pattern: \d{1,16}
java.lang.String vendorName
Constraints:
Pattern: [\w :+=./\\-]*
java.lang.String hsmType
Constraints:
Pattern: [\w :+=./\\-]*
java.lang.String softwareVersion
Constraints:
Pattern: [\w :+=./\\-]*
java.lang.String sshPublicKey
Constraints:
Pattern: [a-zA-Z0-9+/= ._:\\@-]*
java.lang.String sshKeyLastUpdated
Constraints:
Pattern: \d*
java.lang.String serverCertUri
Constraints:
Pattern: [\w :+=./\\-]*
java.lang.String serverCertLastUpdated
Constraints:
Pattern: \d*
com.amazonaws.internal.ListWithAutoConstructFlag<T> partitions
java.lang.String clientArn
Constraints:
Pattern: arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\-]*:[0-9]{12}:client-[0-9a-f]{8}
java.lang.String certificateFingerprint
Constraints:
Pattern: ([0-9a-fA-F][0-9a-fA-F]:){15}[0-9a-fA-F][0-9a-fA-F]
java.lang.String clientArn
Constraints:
Pattern: arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\-]*:[0-9]{12}:client-[0-9a-f]{8}
java.lang.String certificate
Constraints:
Length: 600 - 2400
Pattern: [\w :+=./\n-]*
java.lang.String certificateFingerprint
Constraints:
Pattern: ([0-9a-fA-F][0-9a-fA-F]:){15}[0-9a-fA-F][0-9a-fA-F]
java.lang.String lastModifiedTimestamp
Constraints:
Pattern: \d*
java.lang.String label
Constraints:
Pattern: [a-zA-Z0-9_.-]{1,64}
java.lang.String clientArn
Constraints:
Pattern: arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\-]*:[0-9]{12}:client-[0-9a-f]{8}
java.lang.String clientVersion
Constraints:
Allowed Values: 5.1, 5.3
com.amazonaws.internal.ListWithAutoConstructFlag<T> hapgList
java.lang.String configType
Constraints:
Pattern: [\w :+=./\\-]*
java.lang.String configFile
Constraints:
Pattern: [\w :+=./\\-]*
java.lang.String configCred
Constraints:
Pattern: [\w :+=./\\-]*
java.lang.String nextToken
Constraints:
Pattern: [a-zA-Z0-9+/]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> hapgList
java.lang.String nextToken
Constraints:
Pattern: [a-zA-Z0-9+/]*
java.lang.String nextToken
Constraints:
Pattern: [a-zA-Z0-9+/]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> hsmList
java.lang.String nextToken
Constraints:
Pattern: [a-zA-Z0-9+/]*
java.lang.String nextToken
Constraints:
Pattern: [a-zA-Z0-9+/]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> clientList
java.lang.String nextToken
Constraints:
Pattern: [a-zA-Z0-9+/]*
java.lang.String hapgArn
Constraints:
Pattern: arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\-]*:[0-9]{12}:hapg-[0-9a-f]{8}
java.lang.String label
Constraints:
Pattern: [a-zA-Z0-9_.-]{1,64}
com.amazonaws.internal.ListWithAutoConstructFlag<T> partitionSerialList
java.lang.String hsmArn
Constraints:
Pattern: arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\-]*:[0-9]{12}:hsm-[0-9a-f]{8}
java.lang.String subnetId
Constraints:
Pattern: subnet-[0-9a-f]{8}
java.lang.String eniIp
Constraints:
Pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}
java.lang.String iamRoleArn
Constraints:
Pattern: arn:aws(-iso)?:iam::[0-9]{12}:role/[a-zA-Z0-9_\+=,\.\-@]{1,64}
java.lang.String externalId
Constraints:
Pattern: [\w :+=./-]*
java.lang.String syslogIp
Constraints:
Pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}
java.lang.String clientArn
Constraints:
Pattern: arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\-]*:[0-9]{12}:client-[0-9a-f]{8}
java.lang.String certificate
Constraints:
Length: 600 - 2400
Pattern: [\w :+=./\n-]*
java.lang.String options
Example: {"Statement":
[{"Effect":"Allow", "Action": "*", "Resource":
"arn:aws:cs:us-east-1:1234567890:search/movies", "Condition": {
"IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }},
{"Effect":"Allow", "Action": "*", "Resource":
"arn:aws:cs:us-east-1:1234567890:documents/movies", "Condition": {
"IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }} ] }
OptionStatus status
java.lang.Boolean options
OptionStatus status
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DomainStatus domainStatus
java.lang.String options
IndexField to use as the default search
field. The default is an empty string, which automatically searches
all text fields.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
OptionStatus status
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
IndexField indexField
IndexFieldType indicates which of the
options will be present. It is invalid to specify options for a type
other than the IndexFieldType.IndexFieldStatus indexField
IndexField and its current status.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
NamedRankExpression rankExpression
RankExpressionStatus rankExpression
RankExpression and its current status.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DomainStatus domainStatus
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String indexFieldName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
IndexFieldStatus indexField
IndexField and its current status.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String rankName
RankExpression to delete.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
RankExpressionStatus rankExpression
RankExpression and its current status.AvailabilityOptionsStatus availabilityOptions
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DefaultSearchFieldStatus defaultSearchField
IndexField to use for search requests
issued with the q parameter. The default is the empty
string, which automatically searches all text fields.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
DescribeIndexFields response to the specified
fields.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> rankNames
DescribeRankExpressions response to the
specified fields.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
AccessPoliciesStatus accessPolicies
PolicyDocument that specifies access policies for the
search domain's services, and the current status of those policies.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
StemmingOptionsStatus stems
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
StopwordOptionsStatus stopwords
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
SynonymOptionsStatus synonyms
java.lang.String domainId
Constraints:
Length: 1 - 64
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.Boolean created
java.lang.Boolean deleted
java.lang.Long numSearchableDocs
Constraints:
Range: 0 -
ServiceEndpoint docService
ServiceEndpoint searchService
java.lang.Boolean requiresIndexDocuments
java.lang.Boolean processing
java.lang.String searchInstanceType
java.lang.Integer searchPartitionCount
Constraints:
Range: 1 -
java.lang.Integer searchInstanceCount
Constraints:
Range: 1 -
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String indexFieldName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
java.lang.String indexFieldType
Constraints:
Allowed Values: uint, literal, text
UIntOptions uIntOptions
IndexFieldType specifies the field is of type unsigned
integer.LiteralOptions literalOptions
IndexFieldType
specifies the field is of type literal.TextOptions textOptions
IndexFieldType
specifies the field is of type text.com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceAttributes
IndexField. When one or more
source attributes are specified, an optional data transformation can
be applied to the source data when populating the index field. You can
configure a maximum of 20 sources for an IndexField.IndexField options
IndexFieldType indicates which of the
options will be present. It is invalid to specify options for a type
other than the IndexFieldType.OptionStatus status
java.lang.String defaultValue
Constraints:
Length: 0 - 1024
java.lang.Boolean searchEnabled
java.lang.Boolean facetEnabled
java.lang.Boolean resultEnabled
java.lang.String rankName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
java.lang.String rankExpression
RankExpression syntax is
based on JavaScript expressions and supports:a || b
evaluates to the value a, if a is true,
without evaluating b at all+ - * /
%abs ceil erf exp
floor lgamma ln log2 log10 max min sqrt powacosh acos asinh asin atanh
atan cosh cos sinh sin tanh tanrandtimemin max functions
that operate on a variable argument listIntermediate
results are calculated as double precision floating point values. The
final return value of a RankExpression is automatically
converted from floating point to a 32-bit unsigned integer by rounding
to the nearest integer, with a natural floor of 0 and a ceiling of
max(uint32_t), 4294967295. Mathematical errors such as dividing by 0
will fail during evaluation and return a value of 0.
The source
data for a RankExpression can be the name of an
IndexField of type uint, another
RankExpression or the reserved name
text_relevance. The text_relevance source is defined to return
an integer from 0 to 1000 (inclusive) to indicate how relevant a
document is to the search request, taking into account repetition of
search terms in the document and proximity of search terms to each
other in each matching IndexField in the document.
For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.
Constraints:
Length: 1 - 10240
java.util.Date creationDate
java.util.Date updateDate
java.lang.Integer updateVersion
Constraints:
Range: 0 -
java.lang.String state
RequiresIndexDocuments: the option's latest value
will not be visible in searches until IndexDocuments has been
called and indexing is complete.Processing: the
option's latest value is not yet visible in all searches but is in the
process of being activated. Active: the
option's latest value is completely visible. Any warnings or messages
generated during processing are provided in
Diagnostics.
Constraints:
Allowed Values: RequiresIndexDocuments, Processing, Active
java.lang.Boolean pendingDeletion
NamedRankExpression options
OptionStatus status
java.lang.String arn
java.lang.String endpoint
java.lang.String sourceDataFunction
Constraints:
Allowed Values: Copy, TrimTitle, Map
SourceData sourceDataCopy
IndexField.SourceDataTrimTitle sourceDataTrimTitle
IndexField. This can be used to create an
IndexField you can use for sorting.SourceDataMap sourceDataMap
IndexField.java.lang.String sourceName
IndexField.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
java.lang.String defaultValue
Constraints:
Length: 0 - 1024
java.lang.String sourceName
IndexField.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
java.lang.String defaultValue
Constraints:
Length: 0 - 1024
java.util.Map<K,V> cases
java.lang.String sourceName
IndexField.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
java.lang.String defaultValue
Constraints:
Length: 0 - 1024
java.lang.String separator
java.lang.String language
Constraints:
Pattern: [a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*
java.lang.String options
{ "stems": {"people": "person", "walking":
"walk"} }OptionStatus status
java.lang.String options
{ "stopwords": ["a", "an", "the", "of"] }OptionStatus status
java.lang.String options
{ "synonyms": {"cat": ["feline",
"kitten"], "puppy": "dog"} }OptionStatus status
java.lang.String defaultValue
Constraints:
Length: 0 - 1024
java.lang.Boolean facetEnabled
java.lang.Boolean resultEnabled
java.lang.String textProcessor
cs_text_no_stemming: turns off stemming for the
field.Default: none
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.Boolean multiAZ
false.AvailabilityOptionsStatus availabilityOptions
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String defaultSearchField
q parameter, or if a match
expression specified with the bq parameter does not
constrain the search to a particular field. The default is an empty
string, which automatically searches all text fields.DefaultSearchFieldStatus defaultSearchField
DefaultSearchField configured for this
search domain and its current status.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String accessPolicies
Example: {"Statement":
[{"Effect":"Allow", "Action": "*", "Resource":
"arn:aws:cs:us-east-1:1234567890:search/movies", "Condition": {
"IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }},
{"Effect":"Allow", "Action": "*", "Resource":
"arn:aws:cs:us-east-1:1234567890:documents/movies", "Condition": {
"IpAddress": { "aws:SourceIp": ["203.0.113.1/32"] } }} ] }
AccessPoliciesStatus accessPolicies
PolicyDocument that specifies access policies for the
search domain's services, and the current status of those policies.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String stems
{ "stems": {"people": "person", "walking":
"walk"} }StemmingOptionsStatus stems
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String stopwords
{ "stopwords": ["a", "an", "the", "of"] }StopwordOptionsStatus stopwords
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String synonyms
{ "synonyms": {"cat": ["feline",
"kitten"], "puppy": "dog"} }SynonymOptionsStatus synonyms
java.lang.String id
java.util.Map<K,V> fields
java.util.Map<K,V> highlights
java.lang.Long found
java.lang.Long start
java.lang.String cursor
com.amazonaws.internal.ListWithAutoConstructFlag<T> hit
java.lang.String cursor
size parameter to control the number of
hits to include in each response. You can specify either the
cursor or start parameter in a request; they
are mutually exclusive. To get the first cursor, set the cursor value
to initial. In subsequent requests, specify the cursor
value returned in the hits section of the response. For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.
java.lang.String expr
You specify the expressions in JSON
using the form {"EXPRESSIONNAME":"EXPRESSION"}. You can
define and use multiple expressions in a search request. For example:
{"expression1":"_score*rating",
"expression2":"(1/rank)*year"}
For information about the variables, operators, and functions you can use in expressions, see Writing Expressions in the Amazon CloudSearch Developer Guide.
java.lang.String facet
{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}.
You can specify the following faceting options:
buckets specifies an array of the facet values or
ranges to count. Ranges are specified using the same syntax that you
use to search for a range of values. For more information, see
Searching for a Range of Values in the Amazon CloudSearch
Developer Guide. Buckets are returned in the order they are
specified in the request. The sort and size
options are not valid if you specify buckets.
size specifies the maximum number of facets to include
in the results. By default, Amazon CloudSearch returns counts for the
top 10. The size parameter is only valid when you specify
the sort option; it cannot be used in conjunction with
buckets.
sort specifies how
you want to sort the facets in the results: bucket or
count. Specify bucket to sort alphabetically
or numerically by facet value (in ascending order). Specify
count to sort by the facet counts computed for each facet
value (in descending order). To retrieve facet counts for particular
values or ranges of values, use the buckets option
instead of sort.
If no facet options are specified, facet counts are computed for all field values, the facets are sorted by facet count, and the top 10 facets are returned in the results.
To count particular buckets of values, use the
buckets option. For example, the following request uses
the buckets option to calculate and return facet counts
by decade.
{"year":{"buckets":["[1970,1979]","[1980,1989]","[1990,1999]","[2000,2009]","[2010,}"]}}
To sort facets by facet count, use the count
option. For example, the following request sets the sort
option to count to sort the facet values by facet count,
with the facet values that have the most matching documents listed
first. Setting the size option to 3 returns only the top
three facet values.
{"year":{"sort":"count","size":3}}
To sort the facets by value, use the bucket
option. For example, the following request sets the sort
option to bucket to sort the facet values numerically by
year, with earliest year listed first.
{"year":{"sort":"bucket"}}
For more information, see Getting and Using Facet Information in the Amazon CloudSearch Developer Guide.
java.lang.String filterQuery
filterQuery in conjunction with the query
parameter to filter the documents that match the constraints specified
in the query parameter. Specifying a filter controls only
which matching documents are included in the results, it has no effect
on how they are scored and sorted. The filterQuery
parameter supports the full structured query syntax. For more information about using filters, see Filtering Matching Documents in the Amazon CloudSearch Developer Guide.
java.lang.String highlight
text or
text-array fields. Each specified field must be highlight
enabled in the domain configuration. The fields and options are
specified in JSON using the form
{"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}.
You can specify the following highlight options:
format: specifies the format of the data in the text
field: text or html. When data is returned
as HTML, all non-alphanumeric characters are encoded. The default is
html. max_phrases: specifies the
maximum number of occurrences of the search term(s) you want to
highlight. By default, the first occurrence is highlighted. pre_tag: specifies the string to prepend to an occurrence
of a search term. The default for HTML highlights is
. The default for text highlights is *.
post_tag: specifies the string to append to an
occurrence of a search term. The default for HTML highlights is
. The default for text highlights is *.
If no highlight options are specified for a field, the
returned field text is treated as HTML and the first match is
highlighted with emphasis tags: search-term.
For example, the following request retrieves highlights for the
actors and title fields.
{
"actors": {}, "title": {"format": "text","max_phrases": 2,"pre_tag":
"","post_tag": ""} }
java.lang.Boolean partial
java.lang.String query
queryOptions
parameter. By default, the simple query parser is used to
process requests. To use the structured,
lucene, or dismax query parser, you must
also specify the queryParser parameter. For more information about specifying search criteria, see Searching Your Data in the Amazon CloudSearch Developer Guide.
java.lang.String queryOptions
queryParser parameter. You specify the options in JSON
using the following form
{"OPTION1":"VALUE1","OPTION2":VALUE2"..."OPTIONN":"VALUEN"}.
The options you can configure vary according to which parser you use:
defaultOperator: The default operator used
to combine individual terms in the search string. For example:
defaultOperator: 'or'. For the dismax
parser, you specify a percentage that represents the percentage of
terms in the search string (rounded down) that must match, rather than
a default operator. A value of 0% is the equivalent to
OR, and a value of 100% is equivalent to AND. The
percentage must be specified as a value in the range 0-100 followed by
the percent (%) symbol. For example, defaultOperator:
50%. Valid values: and, or, a
percentage in the range 0%-100% (dismax). Default:
and (simple, structured,
lucene) or 100 (dismax). Valid
for: simple, structured,
lucene, and dismax.fields: An array of the fields to search when no
fields are specified in a search. If no fields are specified in a
search and this option is not specified, all text and text-array
fields are searched. You can specify a weight for each field to
control the relative importance of each field when Amazon CloudSearch
calculates relevance scores. To specify a field weight, append a caret
(^) symbol and the weight to the field name. For example,
to boost the importance of the title field over the
description field you could specify:
"fields":["title^5","description"]. Valid values: The
name of any configured field and an optional numeric value greater
than zero. Default: All text and text-array
fields. Valid for: simple, structured,
lucene, and dismax.operators: An array of the operators or special
characters you want to disable for the simple query parser. If you
disable the and, or, or not
operators, the corresponding operators (+,
|, -) have no special meaning and are
dropped from the search string. Similarly, disabling
prefix disables the wildcard operator (*)
and disabling phrase disables the ability to search for
phrases by enclosing phrases in double quotes. Disabling precedence
disables the ability to control order of precedence using parentheses.
Disabling near disables the ability to use the ~ operator
to perform a sloppy phrase search. Disabling the fuzzy
operator disables the ability to use the ~ operator to perform a fuzzy
search. escape disables the ability to use a backslash
(\) to escape special characters within the search
string. Disabling whitespace is an advanced option that prevents the
parser from tokenizing on whitespace, which can be useful for
Vietnamese. (It prevents Vietnamese words from being split
incorrectly.) For example, you could disable all operators other than
the phrase operator to support just simple term and phrase queries:
"operators":["and","not","or", "prefix"]. Valid values:
and, escape, fuzzy,
near, not, or,
phrase, precedence, prefix,
whitespace. Default: All operators and special characters
are enabled. Valid for: simple.phraseFields: An array of the text or
text-array fields you want to use for phrase searches.
When the terms in the search string appear in close proximity within a
field, the field scores higher. You can specify a weight for each
field to boost that score. The phraseSlop option controls
how much the matches can deviate from the search string and still be
boosted. To specify a field weight, append a caret (^)
symbol and the weight to the field name. For example, to boost phrase
matches in the title field over the abstract
field, you could specify: "phraseFields":["title^3",
"plot"] Valid values: The name of any text or
text-array field and an optional numeric value greater
than zero. Default: No fields. If you don't specify any fields with
phraseFields, proximity scoring is disabled even if
phraseSlop is specified. Valid for:
dismax.phraseSlop: An integer
value that specifies how much matches can deviate from the search
phrase and still be boosted according to the weights specified in the
phraseFields option; for example, phraseSlop:
2. You must also specify phraseFields to enable
proximity scoring. Valid values: positive integers. Default: 0. Valid
for: dismax.explicitPhraseSlop: An
integer value that specifies how much a match can deviate from the
search phrase when the phrase is enclosed in double quotes in the
search string. (Phrases that exceed this proximity distance are not
considered a match.) For example, to specify a slop of three for
dismax phrase queries, you would specify
"explicitPhraseSlop":3. Valid values: positive integers.
Default: 0. Valid for: dismax.tieBreaker: When a term in the search string is found
in a document's field, a score is calculated for that field based on
how common the word is in that field compared to other documents. If
the term occurs in multiple fields within a document, by default only
the highest scoring field contributes to the document's overall score.
You can specify a tieBreaker value to enable the matches
in lower-scoring fields to contribute to the document's score. That
way, if two documents have the same max field score for a particular
term, the score for the document that has matches in more fields will
be higher. The formula for calculating the score with a tieBreaker is
(max field score) + (tieBreaker) * (sum of the scores for the
rest of the matching fields). Set tieBreaker to 0
to disregard all but the highest scoring field (pure max):
"tieBreaker":0. Set to 1 to sum the scores from all
fields (pure sum): "tieBreaker":1. Valid values: 0.0 to
1.0. Default: 0.0. Valid for: dismax. java.lang.String queryParser
queryParser is not specified, Amazon CloudSearch uses the
simple query parser. Amazon CloudSearch supports four query parsers:
simple: perform simple searches
of text and text-array fields. By default,
the simple query parser searches all text
and text-array fields. You can specify which fields to
search by with the queryOptions parameter. If you prefix
a search term with a plus sign (+) documents must contain the term to
be considered a match. (This is the default, unless you configure the
default operator with the queryOptions parameter.) You
can use the - (NOT), | (OR), and
* (wildcard) operators to exclude particular terms, find
results that match any of the specified terms, or search for a prefix.
To search for a phrase rather than individual terms, enclose the
phrase in double quotes. For more information, see Searching
for Text in the Amazon CloudSearch Developer Guide. structured: perform advanced searches by combining
multiple expressions to define the search criteria. You can also
search within particular fields, search for values and ranges of
values, and use advanced options such as term boosting,
matchall, and near. For more information,
see Constructing
Compound Queries in the Amazon CloudSearch Developer Guide.
lucene: search using the Apache Lucene query
parser syntax. For more information, see Apache
Lucene Query Parser Syntax. dismax: search
using the simplified subset of the Apache Lucene query parser syntax
defined by the DisMax query parser. For more information, see DisMax
Query Parser Syntax.
Constraints:
Allowed Values: simple, structured, lucene, dismax
java.lang.String returnValue
_all_fields). To return only the document IDs for the
matching documents, specify _no_fields. To retrieve the
relevance score calculated for each document, specify
_score.java.lang.Long size
java.lang.String sort
asc or desc) for each field; for example,
year desc,title asc. To use a field to sort results, the
field must be sort-enabled in the domain configuration. Array type
fields cannot be used for sorting. If no sort parameter
is specified, results are sorted by their default relevance scores in
descending order: _score desc. You can also sort by
document ID (_id asc) and version (_version
desc). For more information, see Sorting Results in the Amazon CloudSearch Developer Guide.
java.lang.Long start
start or cursor
parameter in a request, they are mutually exclusive. For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.
SearchStatus status
Hits hits
java.util.Map<K,V> facets
java.lang.String query
java.lang.Long found
com.amazonaws.internal.ListWithAutoConstructFlag<T> suggestions
SuggestStatus status
SuggestRequest. Contains the resource ID
(rid) and how long it took to process the request
(timems).SuggestModel suggest
java.lang.Long contentLength
java.io.InputStream documents
java.lang.String contentType
Constraints:
Allowed Values: application/json, application/xml
java.lang.String status
UploadDocumentsRequest.java.lang.Long adds
java.lang.Long deletes
com.amazonaws.internal.ListWithAutoConstructFlag<T> warnings
java.lang.String options
OptionStatus status
java.lang.String synonyms
java.lang.String stopwords
["a", "an", "the", "of"]. The stopwords
dictionary must explicitly list each word you want to ignore.
Wildcards and regular expressions are not supported.java.lang.String stemmingDictionary
{"term1": "stem1",
"term2": "stem2", "term3": "stem3"}. The stemming dictionary is
applied in addition to any algorithmic stemming. This enables you to
override the results of the algorithmic stemming to correct specific
cases of overstemming or understemming. The maximum size of a stemming
dictionary is 500 KB.java.lang.String japaneseTokenizationDictionary
java.lang.String algorithmicStemming
none,
minimal, light, or full. The
available levels vary depending on the language. For more information,
see Language Specific Text Processing Settings in the
Amazon CloudSearch Developer Guide
Constraints:
Allowed Values: none, minimal, light, full
java.lang.String analysisSchemeName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
java.lang.String analysisSchemeLanguage
mul for multiple languages.
Constraints:
Allowed Values: ar, bg, ca, cs, da, de, el, en, es, eu, fa, fi, fr, ga, gl, he, hi, hu, hy, id, it, ja, ko, lv, mul, nl, no, pt, ro, ru, sv, th, tr, zh-Hans, zh-Hant
AnalysisOptions analysisOptions
AnalysisScheme options
Synonyms, Stopwords,
StemmingDictionary,
JapaneseTokenizationDictionary and
AlgorithmicStemming.OptionStatus status
java.lang.Boolean options
OptionStatus status
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
DomainStatus domainStatus
java.lang.String defaultValue
Constraints:
Length: 0 - 1024
java.lang.String sourceFields
Constraints:
Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
java.lang.Boolean facetEnabled
java.lang.Boolean searchEnabled
java.lang.Boolean returnEnabled
java.lang.String defaultValue
Constraints:
Length: 0 - 1024
java.lang.String sourceField
_id.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
java.lang.Boolean facetEnabled
java.lang.Boolean searchEnabled
java.lang.Boolean returnEnabled
java.lang.Boolean sortEnabled
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
AnalysisScheme analysisScheme
Synonyms, Stopwords,
StemmingDictionary,
JapaneseTokenizationDictionary and
AlgorithmicStemming.AnalysisSchemeStatus analysisScheme
AnalysisScheme.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
Expression expression
ExpressionStatus expression
Expression and its current status.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
IndexField indexField
IndexFieldStatus indexField
IndexField and its current status.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
Suggester suggester
FuzzyMatching, SortExpression.SuggesterStatus suggester
Suggester and its current status.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String analysisSchemeName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
AnalysisSchemeStatus analysisScheme
DomainStatus domainStatus
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String expressionName
Expression to delete.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
ExpressionStatus expression
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String indexFieldName
Constraints:
Length: 1 - 64
Pattern: ([a-z][a-z0-9_]*\*?|\*[a-z0-9_]*)
IndexFieldStatus indexField
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String suggesterName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
SuggesterStatus suggester
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> analysisSchemeNames
java.lang.Boolean deployed
true) or
include any pending changes (false). Defaults to
false.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.Boolean deployed
true) or
include any pending changes (false). Defaults to
false.AvailabilityOptionsStatus availabilityOptions
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> expressionNames
DescribeExpressions response to the
specified expressions. If not specified, all expressions are shown.java.lang.Boolean deployed
true) or
include any pending changes (false). Defaults to
false.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
java.lang.Boolean deployed
true) or
include any pending changes (false). Defaults to
false.java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
ScalingParametersStatus scalingParameters
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.Boolean deployed
true) or
include any pending changes (false). Defaults to
false.AccessPoliciesStatus accessPolicies
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> suggesterNames
java.lang.Boolean deployed
true) or
include any pending changes (false). Defaults to
false.java.lang.String sourceField
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
java.lang.String fuzzyMatching
none, low, or high. With none,
the specified string is treated as an exact prefix. With low,
suggestions must differ from the specified string by no more than one
character. With high, suggestions can differ by up to two characters.
The default is none.
Constraints:
Allowed Values: none, low, high
java.lang.String sortExpression
_score value. To sort suggestions using a numeric field
or existing expression, simply specify the name of the field or
expression. If no expression is configured for the suggester, the
suggestions are sorted with the closest matches listed first.java.lang.String domainId
Constraints:
Length: 1 - 64
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String aRN
java.lang.Boolean created
java.lang.Boolean deleted
ServiceEndpoint docService
ServiceEndpoint searchService
java.lang.Boolean requiresIndexDocuments
java.lang.Boolean processing
java.lang.String searchInstanceType
java.lang.Integer searchPartitionCount
Constraints:
Range: 1 -
java.lang.Integer searchInstanceCount
Constraints:
Range: 1 -
Limits limits
java.lang.Double defaultValue
java.lang.String sourceFields
Constraints:
Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
java.lang.Boolean facetEnabled
java.lang.Boolean searchEnabled
java.lang.Boolean returnEnabled
java.lang.Double defaultValue
java.lang.String sourceField
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
java.lang.Boolean facetEnabled
java.lang.Boolean searchEnabled
java.lang.Boolean returnEnabled
java.lang.Boolean sortEnabled
java.lang.String expressionName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
java.lang.String expressionValue
Expression syntax is based on JavaScript
expressions. For more information, see Configuring Expressions in the Amazon
CloudSearch Developer Guide.
Constraints:
Length: 1 - 10240
Expression options
OptionStatus status
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String indexFieldName
Constraints:
Length: 1 - 64
Pattern: ([a-z][a-z0-9_]*\*?|\*[a-z0-9_]*)
java.lang.String indexFieldType
Constraints:
Allowed Values: int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array
IntOptions intOptions
IndexFieldType specifies the field is of type
int. All options are enabled by default.DoubleOptions doubleOptions
IndexFieldType specifies the field is of type
double. All options are enabled by default.LiteralOptions literalOptions
IndexFieldType
specifies the field is of type literal. All options are
enabled by default.TextOptions textOptions
IndexFieldType
specifies the field is of type text. A text
field is always searchable. All options are enabled by default.DateOptions dateOptions
IndexFieldType specifies
the field is of type date. All options are enabled by
default.LatLonOptions latLonOptions
IndexFieldType specifies the field is of type
latlon. All options are enabled by default.IntArrayOptions intArrayOptions
IndexFieldType specifies the field is of type
int-array. All options are enabled by default.DoubleArrayOptions doubleArrayOptions
IndexFieldType
specifies the field is of type double-array. All options
are enabled by default.LiteralArrayOptions literalArrayOptions
IndexFieldType specifies the field is of type
literal-array. All options are enabled by default.TextArrayOptions textArrayOptions
IndexFieldType specifies the field is of type
text-array. A text-array field is always
searchable. All options are enabled by default.DateArrayOptions dateArrayOptions
IndexFieldType specifies the field is of type
date-array. All options are enabled by default.IndexField options
IndexFieldType.OptionStatus status
java.lang.Long defaultValue
java.lang.String sourceFields
Constraints:
Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
java.lang.Boolean facetEnabled
java.lang.Boolean searchEnabled
java.lang.Boolean returnEnabled
java.lang.Long defaultValue
java.lang.String sourceField
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
java.lang.Boolean facetEnabled
java.lang.Boolean searchEnabled
java.lang.Boolean returnEnabled
java.lang.Boolean sortEnabled
java.lang.String defaultValue
Constraints:
Length: 0 - 1024
java.lang.String sourceField
_id.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
java.lang.Boolean facetEnabled
java.lang.Boolean searchEnabled
java.lang.Boolean returnEnabled
java.lang.Boolean sortEnabled
java.lang.String defaultValue
Constraints:
Length: 0 - 1024
java.lang.String sourceFields
Constraints:
Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
java.lang.Boolean facetEnabled
java.lang.Boolean searchEnabled
java.lang.Boolean returnEnabled
java.lang.String defaultValue
Constraints:
Length: 0 - 1024
java.lang.String sourceField
_id.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
java.lang.Boolean facetEnabled
java.lang.Boolean searchEnabled
java.lang.Boolean returnEnabled
java.lang.Boolean sortEnabled
java.util.Date creationDate
java.util.Date updateDate
java.lang.Integer updateVersion
Constraints:
Range: 0 -
java.lang.String state
RequiresIndexDocuments: the option's latest value
will not be deployed until IndexDocuments has been called and
indexing is complete.Processing: the option's
latest value is in the process of being activated. Active: the option's latest value is completely
deployed.FailedToValidate: the option value is
not compatible with the domain's data and cannot be used to index the
data. You must either modify the option value or update or remove the
incompatible documents.
Constraints:
Allowed Values: RequiresIndexDocuments, Processing, Active, FailedToValidate
java.lang.Boolean pendingDeletion
java.lang.String desiredInstanceType
search.m1.small.
Constraints:
Allowed Values: search.m1.small, search.m1.large, search.m2.xlarge, search.m2.2xlarge
java.lang.Integer desiredReplicationCount
Constraints:
Range: 0 -
java.lang.Integer desiredPartitionCount
m2.2xlarge as the desired
instance type.
Constraints:
Range: 0 -
ScalingParameters options
OptionStatus status
java.lang.String suggesterName
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
DocumentSuggesterOptions documentSuggesterOptions
Suggester options
FuzzyMatching, SortExpression.OptionStatus status
java.lang.String defaultValue
Constraints:
Length: 0 - 1024
java.lang.String sourceFields
Constraints:
Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
java.lang.Boolean returnEnabled
java.lang.Boolean highlightEnabled
java.lang.String analysisScheme
text-array field.
Constraints:
Pattern: [\S]+
java.lang.String defaultValue
Constraints:
Length: 0 - 1024
java.lang.String sourceField
_id.
Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*
java.lang.Boolean returnEnabled
java.lang.Boolean sortEnabled
java.lang.Boolean highlightEnabled
java.lang.String analysisScheme
text field.
Constraints:
Pattern: [\S]+
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.Boolean multiAZ
false.AvailabilityOptionsStatus availabilityOptions
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
ScalingParameters scalingParameters
ScalingParametersStatus scalingParameters
java.lang.String domainName
Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+
java.lang.String accessPolicies
AccessPoliciesStatus accessPolicies
java.lang.String name
java.lang.String s3BucketName
java.lang.String s3KeyPrefix
java.lang.String snsTopicName
java.lang.Boolean includeGlobalServiceEvents
java.lang.String cloudWatchLogsLogGroupArn
java.lang.String cloudWatchLogsRoleArn
java.lang.String name
java.lang.String s3BucketName
java.lang.String s3KeyPrefix
java.lang.String snsTopicName
java.lang.Boolean includeGlobalServiceEvents
java.lang.String cloudWatchLogsLogGroupArn
java.lang.String cloudWatchLogsRoleArn
java.lang.Boolean isLogging
java.lang.String latestDeliveryError
java.lang.String latestNotificationError
java.util.Date latestDeliveryTime
java.util.Date latestNotificationTime
java.util.Date startLoggingTime
java.util.Date stopLoggingTime
java.lang.String latestCloudWatchLogsDeliveryError
java.util.Date latestCloudWatchLogsDeliveryTime
java.lang.String name
java.lang.String s3BucketName
java.lang.String s3KeyPrefix
java.lang.String snsTopicName
java.lang.Boolean includeGlobalServiceEvents
java.lang.String cloudWatchLogsLogGroupArn
java.lang.String cloudWatchLogsRoleArn
java.lang.String name
java.lang.String s3BucketName
java.lang.String s3KeyPrefix
java.lang.String snsTopicName
java.lang.Boolean includeGlobalServiceEvents
java.lang.String cloudWatchLogsLogGroupArn
java.lang.String cloudWatchLogsRoleArn
java.lang.String name
java.lang.String s3BucketName
java.lang.String s3KeyPrefix
java.lang.String snsTopicName
java.lang.Boolean includeGlobalServiceEvents
java.lang.String cloudWatchLogsLogGroupArn
java.lang.String cloudWatchLogsRoleArn
java.lang.String alarmName
Constraints:
Length: 1 - 255
java.util.Date timestamp
java.lang.String historyItemType
Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action
java.lang.String historySummary
Constraints:
Length: 1 - 255
java.lang.String historyData
Constraints:
Length: 1 - 4095
java.util.Date timestamp
java.lang.Double sampleCount
java.lang.Double average
java.lang.Double sum
java.lang.Double minimum
java.lang.Double maximum
java.lang.String unit
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
java.lang.String alarmName
Constraints:
Length: 1 - 255
java.lang.String historyItemType
Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action
java.util.Date startDate
java.util.Date endDate
java.lang.Integer maxRecords
Constraints:
Range: 1 - 100
java.lang.String nextToken
java.lang.String metricName
Constraints:
Length: 1 - 255
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String statistic
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
java.lang.Integer period
Constraints:
Range: 60 -
java.lang.String unit
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarmNames
Constraints:
Length: 0 - 100
java.lang.String alarmNamePrefix
AlarmNames cannot be specified if
this parameter is specified.
Constraints:
Length: 1 - 255
java.lang.String stateValue
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
java.lang.String actionPrefix
Constraints:
Length: 1 - 1024
java.lang.Integer maxRecords
Constraints:
Range: 1 - 100
java.lang.String nextToken
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String metricName
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
java.util.Date startTime
java.util.Date endTime
java.lang.Integer period
Period must be at least 60 seconds and must be a multiple
of 60. The default value is 60.
Constraints:
Range: 60 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> statistics
Constraints:
Length: 1 - 5
java.lang.String unit
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String metricName
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
java.lang.String nextToken
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String metricName
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
java.lang.String alarmName
Constraints:
Length: 1 - 255
java.lang.String alarmArn
Constraints:
Length: 1 - 1600
java.lang.String alarmDescription
Constraints:
Length: 0 - 255
java.util.Date alarmConfigurationUpdatedTimestamp
java.lang.Boolean actionsEnabled
com.amazonaws.internal.ListWithAutoConstructFlag<T> oKActions
OK state from any other state. Each action is specified
as an Amazon Resource Number (ARN). Currently the only actions
supported are publishing to an Amazon SNS topic and triggering an Auto
Scaling policy.
Constraints:
Length: 0 - 5
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarmActions
ALARM state from any other state. Each action is
specified as an Amazon Resource Number (ARN). Currently the only
actions supported are publishing to an Amazon SNS topic and triggering
an Auto Scaling policy.
Constraints:
Length: 0 - 5
com.amazonaws.internal.ListWithAutoConstructFlag<T> insufficientDataActions
INSUFFICIENT_DATA state from any other state. Each action
is specified as an Amazon Resource Number (ARN). Currently the only
actions supported are publishing to an Amazon SNS topic or triggering
an Auto Scaling policy.
Constraints:
Length: 0 - 5
java.lang.String stateValue
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
java.lang.String stateReason
Constraints:
Length: 0 - 1023
java.lang.String stateReasonData
Constraints:
Length: 0 - 4000
java.util.Date stateUpdatedTimestamp
java.lang.String metricName
Constraints:
Length: 1 - 255
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String statistic
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
java.lang.Integer period
Constraints:
Range: 60 -
java.lang.String unit
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
java.lang.Integer evaluationPeriods
Constraints:
Range: 1 -
java.lang.Double threshold
java.lang.String comparisonOperator
Statistic and Threshold. The specified
Statistic value is used as the first operand.
Constraints:
Allowed Values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
java.lang.String metricName
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
java.util.Date timestamp
java.lang.Double value
Value
parameter accepts numbers of type Double, Amazon
CloudWatch truncates values with very large exponents. Values with
base-10 exponents greater than 126 (1 x 10^126) are truncated.
Likewise, values with base-10 exponents less than -130 (1 x 10^-130)
are also truncated. StatisticSet statisticValues
java.lang.String unit
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
java.lang.String alarmName
Constraints:
Length: 1 - 255
java.lang.String alarmDescription
Constraints:
Length: 0 - 255
java.lang.Boolean actionsEnabled
com.amazonaws.internal.ListWithAutoConstructFlag<T> oKActions
OK state from any other state. Each action is specified
as an Amazon Resource Number (ARN). Currently the only action
supported is publishing to an Amazon SNS topic or an Amazon Auto
Scaling policy.
Constraints:
Length: 0 - 5
com.amazonaws.internal.ListWithAutoConstructFlag<T> alarmActions
ALARM state from any other state. Each action is
specified as an Amazon Resource Number (ARN). Currently the only
action supported is publishing to an Amazon SNS topic or an Amazon
Auto Scaling policy.
Constraints:
Length: 0 - 5
com.amazonaws.internal.ListWithAutoConstructFlag<T> insufficientDataActions
INSUFFICIENT_DATA state from any other state. Each action
is specified as an Amazon Resource Number (ARN). Currently the only
action supported is publishing to an Amazon SNS topic or an Amazon
Auto Scaling policy.
Constraints:
Length: 0 - 5
java.lang.String metricName
Constraints:
Length: 1 - 255
java.lang.String namespace
Constraints:
Length: 1 - 255
Pattern: [^:].*
java.lang.String statistic
Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
com.amazonaws.internal.ListWithAutoConstructFlag<T> dimensions
Constraints:
Length: 0 - 10
java.lang.Integer period
Constraints:
Range: 60 -
java.lang.String unit
Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
java.lang.Integer evaluationPeriods
Constraints:
Range: 1 -
java.lang.Double threshold
java.lang.String comparisonOperator
Statistic and Threshold. The specified
Statistic value is used as the first operand.
Constraints:
Allowed Values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
java.lang.String alarmName
Constraints:
Length: 1 - 255
java.lang.String stateValue
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
java.lang.String stateReason
Constraints:
Length: 0 - 1023
java.lang.String stateReasonData
Constraints:
Length: 0 - 4000
java.lang.Double sampleCount
java.lang.Double sum
java.lang.Double minimum
java.lang.Double maximum
java.lang.String applicationId
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.util.Date createTime
java.lang.Boolean linkedToGitHub
java.lang.String deploymentConfigName
Constraints:
Length: 1 - 100
MinimumHealthyHosts minimumHealthyHosts
The type parameter takes either of the following values:
The value parameter takes an integer.
For example, to set a minimum of 95% healthy instances, specify a type of FLEET_PERCENT and a value of 95.
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String deploymentGroupName
Constraints:
Length: 1 - 100
java.lang.String deploymentConfigName
To create a custom deployment configuration, call the create deployment configuration operation.
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> ec2TagFilters
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingGroups
java.lang.String serviceRoleArn
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String deploymentGroupName
Constraints:
Length: 1 - 100
RevisionLocation revision
java.lang.String deploymentConfigName
If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default.
Constraints:
Length: 1 - 100
java.lang.String description
java.lang.Boolean ignoreApplicationStopFailures
If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String deploymentGroupName
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> hooksNotCleanedUp
java.lang.String deploymentConfigId
java.lang.String deploymentConfigName
Constraints:
Length: 1 - 100
MinimumHealthyHosts minimumHealthyHosts
java.util.Date createTime
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String deploymentGroupId
java.lang.String deploymentGroupName
Constraints:
Length: 1 - 100
java.lang.String deploymentConfigName
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> ec2TagFilters
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingGroups
java.lang.String serviceRoleArn
RevisionLocation targetRevision
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String deploymentGroupName
Constraints:
Length: 1 - 100
java.lang.String deploymentConfigName
Constraints:
Length: 1 - 100
java.lang.String deploymentId
RevisionLocation revision
java.lang.String status
Constraints:
Allowed Values: Created, Queued, InProgress, Succeeded, Failed, Stopped
ErrorInformation errorInformation
java.util.Date createTime
java.util.Date startTime
Note that in some cases, the reported value of the start time may be later than the complete time. This is due to differences in the clock settings of various back-end servers that participate in the overall deployment process.
java.util.Date completeTime
DeploymentOverview deploymentOverview
java.lang.String description
java.lang.String creator
Constraints:
Allowed Values: user, autoscaling
java.lang.Boolean ignoreApplicationStopFailures
If false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to a specific instance, the deployment will stop to that instance, and the deployment to that instance will be considered to have failed.
java.lang.Long pending
java.lang.Long inProgress
java.lang.Long succeeded
java.lang.Long failed
java.lang.Long skipped
java.lang.String errorCode
Constraints:
Allowed Values: Success, ScriptMissing, ScriptNotExecutable, ScriptTimedOut, ScriptFailed, UnknownError
java.lang.String scriptName
java.lang.String message
java.lang.String logTail
java.lang.String key
java.lang.String value
java.lang.String type
Constraints:
Allowed Values: KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
java.lang.String code
Constraints:
Allowed Values: DEPLOYMENT_GROUP_MISSING, APPLICATION_MISSING, REVISION_MISSING, IAM_ROLE_MISSING, IAM_ROLE_PERMISSIONS, OVER_MAX_INSTANCES, NO_INSTANCES, TIMEOUT, HEALTH_CONSTRAINTS_INVALID, HEALTH_CONSTRAINTS, INTERNAL_ERROR
java.lang.String message
java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> deploymentGroups
java.util.Date firstUsedTime
java.util.Date lastUsedTime
java.util.Date registerTime
ApplicationInfo application
java.lang.String applicationName
Constraints:
Length: 1 - 100
RevisionLocation revision
java.lang.String applicationName
Constraints:
Length: 1 - 100
RevisionLocation revision
GenericRevisionInfo revisionInfo
DeploymentConfigInfo deploymentConfigInfo
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String deploymentGroupName
Constraints:
Length: 1 - 100
DeploymentGroupInfo deploymentGroupInfo
InstanceSummary instanceSummary
DeploymentInfo deploymentInfo
java.lang.String repository
Specified as account/repository.
java.lang.String commitId
java.lang.String deploymentId
java.lang.String instanceId
java.lang.String status
Constraints:
Allowed Values: Pending, InProgress, Succeeded, Failed, Skipped, Unknown
java.util.Date lastUpdatedAt
com.amazonaws.internal.ListWithAutoConstructFlag<T> lifecycleEvents
java.lang.String lifecycleEventName
Diagnostics diagnostics
java.util.Date startTime
java.util.Date endTime
java.lang.String status
Constraints:
Allowed Values: Pending, InProgress, Succeeded, Failed, Skipped, Unknown
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String sortBy
If not specified or set to null, the results will be returned in an arbitrary order.
Constraints:
Allowed Values: registerTime, firstUsedTime, lastUsedTime
java.lang.String sortOrder
If not specified, the results will be sorted in ascending order.
If set to null, the results will be sorted in an arbitrary order.
Constraints:
Allowed Values: ascending, descending
java.lang.String s3Bucket
If set to null, then all of the user's buckets will be searched.
java.lang.String s3KeyPrefix
java.lang.String deployed
Constraints:
Allowed Values: include, exclude, ignore
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> revisions
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> applications
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> deploymentConfigsList
java.lang.String nextToken
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String nextToken
java.lang.String applicationName
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> deploymentGroups
java.lang.String nextToken
java.lang.String deploymentId
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceStatusFilter
com.amazonaws.internal.ListWithAutoConstructFlag<T> instancesList
java.lang.String nextToken
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String deploymentGroupName
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> includeOnlyStatuses
TimeRange createTimeRange
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> deployments
java.lang.String nextToken
java.lang.Integer value
java.lang.String type
For example, for 9 Amazon EC2 instances, if a HOST_COUNT of 6
is specified, deploy to up to 3 instances at a time. The deployment
succeeds if 6 or more instances are successfully deployed to;
otherwise, the deployment fails. If a FLEET_PERCENT of 40 is
specified, deploy to up to 5 instances at a time. The deployment
succeeds if 4 or more instances are successfully deployed to;
otherwise, the deployment fails.
Constraints:
Allowed Values: HOST_COUNT, FLEET_PERCENT
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String description
RevisionLocation revision
java.lang.String revisionType
Constraints:
Allowed Values: S3, GitHub
S3Location s3Location
GitHubLocation gitHubLocation
java.lang.String bucket
java.lang.String key
java.lang.String bundleType
Constraints:
Allowed Values: tar, tgz, zip
java.lang.String version
If the version is not specified, the system will use the most recent version by default.
java.lang.String eTag
If the ETag is not specified as an input parameter, ETag validation of the object will be skipped.
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String currentDeploymentGroupName
Constraints:
Length: 1 - 100
java.lang.String newDeploymentGroupName
Constraints:
Length: 1 - 100
java.lang.String deploymentConfigName
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> ec2TagFilters
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingGroups
java.lang.String serviceRoleArn
com.amazonaws.internal.ListWithAutoConstructFlag<T> hooksNotCleanedUp
java.lang.String identityPoolName
Constraints:
Length: 1 - 128
Pattern: [\w ]+
java.lang.Boolean allowUnauthenticatedIdentities
java.util.Map<K,V> supportedLoginProviders
Constraints:
Length: 0 - 10
java.lang.String developerProviderName
DeveloperProviderName, you can use letters as well as
period (.), underscore (_), and dash
(-). Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.
Constraints:
Length: 1 - 128
Pattern: [\w._-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> openIdConnectProviderARNs
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String identityPoolName
Constraints:
Length: 1 - 128
Pattern: [\w ]+
java.lang.Boolean allowUnauthenticatedIdentities
java.util.Map<K,V> supportedLoginProviders
Constraints:
Length: 0 - 10
java.lang.String developerProviderName
Constraints:
Length: 1 - 128
Pattern: [\w._-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> openIdConnectProviderARNs
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String identityPoolName
Constraints:
Length: 1 - 128
Pattern: [\w ]+
java.lang.Boolean allowUnauthenticatedIdentities
java.util.Map<K,V> supportedLoginProviders
Constraints:
Length: 0 - 10
java.lang.String developerProviderName
Constraints:
Length: 1 - 128
Pattern: [\w._-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> openIdConnectProviderARNs
java.lang.String accountId
Constraints:
Length: 1 - 15
Pattern: \d+
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.util.Map<K,V> logins
The available provider names for Logins are as
follows:
graph.facebook.comaccounts.google.comwww.amazon.com
Constraints:
Length: 0 - 10
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.util.Map<K,V> logins
"developer_provider_name": "developer_user_identifier".
The developer provider is the "domain" by which Cognito will refer to
your users; you provided this domain while creating/updating the
identity pool. The developer user identifier is an identifier from
your backend that uniquely identifies a user. When you create an
identity pool, you can specify the supported logins.
Constraints:
Length: 0 - 10
java.lang.Long tokenDuration
Constraints:
Range: 1 - 86400
java.lang.String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> logins
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.Integer maxResults
Constraints:
Range: 1 - 60
java.lang.String nextToken
Constraints:
Length: 1 -
Pattern: [\S]+
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> identities
java.lang.String nextToken
Constraints:
Length: 1 -
Pattern: [\S]+
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String developerUserIdentifier
java.lang.Integer maxResults
Constraints:
Range: 1 - 60
java.lang.String nextToken
NextToken set to null. After that the service will return
NextToken values as needed. For example, let's say you
make a request with MaxResults set to 10, and there are
20 matches in the database. The service will return a pagination token
as a part of the response. This token can be used to call the API
again and get results starting from the 11th match.
Constraints:
Length: 1 -
Pattern: [\S]+
java.lang.String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> developerUserIdentifierList
java.lang.String nextToken
NextToken set to null. After that the service will return
NextToken values as needed. For example, let's say you
make a request with MaxResults set to 10, and there are
20 matches in the database. The service will return a pagination token
as a part of the response. This token can be used to call the API
again and get results starting from the 11th match.
Constraints:
Length: 1 -
Pattern: [\S]+
java.lang.String sourceUserIdentifier
DeveloperUserIdentifier.java.lang.String destinationUserIdentifier
DeveloperUserIdentifier.java.lang.String developerProviderName
DeveloperProviderName, you can use letters as well as
period (.), underscore (_), and dash (-).
Constraints:
Length: 1 - 128
Pattern: [\w._-]+
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String developerProviderName
Constraints:
Length: 1 - 128
Pattern: [\w._-]+
java.lang.String developerUserIdentifier
java.lang.String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.util.Map<K,V> logins
Constraints:
Length: 0 - 10
com.amazonaws.internal.ListWithAutoConstructFlag<T> loginsToRemove
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String identityPoolName
Constraints:
Length: 1 - 128
Pattern: [\w ]+
java.lang.Boolean allowUnauthenticatedIdentities
java.util.Map<K,V> supportedLoginProviders
Constraints:
Length: 0 - 10
java.lang.String developerProviderName
Constraints:
Length: 1 - 128
Pattern: [\w._-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> openIdConnectProviderARNs
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String identityPoolName
Constraints:
Length: 1 - 128
Pattern: [\w ]+
java.lang.Boolean allowUnauthenticatedIdentities
java.util.Map<K,V> supportedLoginProviders
Constraints:
Length: 0 - 10
java.lang.String developerProviderName
Constraints:
Length: 1 - 128
Pattern: [\w._-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> openIdConnectProviderARNs
java.lang.String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String datasetName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+
java.util.Date creationDate
java.util.Date lastModifiedDate
java.lang.String lastModifiedBy
java.lang.Long dataStorage
java.lang.Long numRecords
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String datasetName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+
Dataset dataset
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String datasetName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+
Dataset dataset
IdentityPoolUsage identityPoolUsage
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
IdentityUsage identityUsage
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
PushSync pushSync
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.Long syncSessionsCount
java.lang.Long dataStorage
java.util.Date lastModifiedDate
java.lang.String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.util.Date lastModifiedDate
java.lang.Integer datasetCount
java.lang.Long dataStorage
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String nextToken
java.lang.Integer maxResults
Constraints:
Length: 0 - 19
Pattern: \d+
com.amazonaws.internal.ListWithAutoConstructFlag<T> identityPoolUsages
java.lang.Integer maxResults
java.lang.Integer count
java.lang.String nextToken
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String datasetName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+
java.lang.Long lastSyncCount
Constraints:
Length: 0 - 19
Pattern: \d+
java.lang.String nextToken
java.lang.Integer maxResults
Constraints:
Length: 0 - 19
Pattern: \d+
java.lang.String syncSessionToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> records
java.lang.String nextToken
java.lang.Integer count
java.lang.Long datasetSyncCount
java.lang.String lastModifiedBy
com.amazonaws.internal.ListWithAutoConstructFlag<T> mergedDatasetNames
java.lang.Boolean datasetExists
java.lang.Boolean datasetDeletedAfterRequestedSyncCount
java.lang.String syncSessionToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> applicationArns
java.lang.String roleArn
Constraints:
Length: 20 - 2048
Pattern: arn:aws:iam::\d+:role/.*
java.lang.String key
Constraints:
Length: 1 - 1024
java.lang.String value
Constraints:
Length: 0 - 1048575
java.lang.Long syncCount
java.util.Date lastModifiedDate
java.lang.String lastModifiedBy
java.util.Date deviceLastModifiedDate
java.lang.String op
Constraints:
Allowed Values: replace, remove
java.lang.String key
Constraints:
Length: 1 - 1024
java.lang.String value
Constraints:
Length: 0 - 1048575
java.lang.Long syncCount
java.util.Date deviceLastModifiedDate
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String platform
Constraints:
Allowed Values: APNS, APNS_SANDBOX, GCM, ADM
java.lang.String token
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
PushSync pushSync
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
PushSync pushSync
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String datasetName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+
java.lang.String deviceId
Constraints:
Length: 1 - 256
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String datasetName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+
java.lang.String deviceId
Constraints:
Length: 1 - 256
java.lang.String identityPoolId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String identityId
Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+
java.lang.String datasetName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.:-]+
java.lang.String deviceId
Constraints:
Length: 1 - 256
com.amazonaws.internal.ListWithAutoConstructFlag<T> recordPatches
java.lang.String syncSessionToken
java.lang.String clientContext
lastModifiedBy field referenced in other methods. The
ClientContext field is not yet implemented.java.lang.String lastStatus
Constraints:
Allowed Values: Success, Failure
java.lang.String lastErrorCode
java.lang.String lastErrorMessage
java.util.Date lastAttemptTime
java.util.Date lastSuccessfulTime
java.lang.String lastStatus
Constraints:
Allowed Values: Success, Failure
java.lang.String lastErrorCode
java.lang.String lastErrorMessage
java.util.Date lastStatusChangeTime
java.lang.String version
java.lang.String accountId
java.util.Date configurationItemCaptureTime
java.lang.String configurationItemStatus
Constraints:
Allowed Values: Ok, Failed, Discovered, Deleted
java.lang.String configurationStateId
java.lang.String configurationItemMD5Hash
You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.
java.lang.String arn
java.lang.String resourceType
Constraints:
Allowed Values: AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway
java.lang.String resourceId
sg-xxxxxx).java.lang.String availabilityZone
java.util.Date resourceCreationTime
java.util.Map<K,V> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> relatedEvents
A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What is AWS CloudTrail?.
An empty field indicates that the current configuration was not initiated by any event.
com.amazonaws.internal.ListWithAutoConstructFlag<T> relationships
java.lang.String configuration
java.lang.String name
Constraints:
Length: 1 - 256
java.lang.String roleARN
java.lang.String name
java.util.Date lastStartTime
java.util.Date lastStopTime
java.lang.Boolean recording
java.lang.String lastStatus
Constraints:
Allowed Values: Pending, Success, Failure
java.lang.String lastErrorCode
java.lang.String lastErrorMessage
java.util.Date lastStatusChangeTime
java.lang.String name
Constraints:
Length: 1 - 256
java.lang.String s3BucketName
java.lang.String s3KeyPrefix
java.lang.String snsTopicARN
java.lang.String name
ConfigExportDeliveryInfo configSnapshotDeliveryInfo
ConfigExportDeliveryInfo configHistoryDeliveryInfo
ConfigStreamDeliveryInfo configStreamDeliveryInfo
java.lang.String resourceType
Constraints:
Allowed Values: AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway
java.lang.String resourceId
sg-xxxxxx).java.util.Date laterTime
java.util.Date earlierTime
java.lang.String chronologicalOrder
Constraints:
Allowed Values: Reverse, Forward
java.lang.Integer limit
Constraints:
Range: 0 - 100
java.lang.String nextToken
ConfigurationRecorder configurationRecorder
DeliveryChannel deliveryChannel
java.lang.String resourceType
Constraints:
Allowed Values: AWS::EC2::CustomerGateway, AWS::EC2::EIP, AWS::EC2::Instance, AWS::EC2::InternetGateway, AWS::EC2::NetworkAcl, AWS::EC2::NetworkInterface, AWS::EC2::RouteTable, AWS::EC2::SecurityGroup, AWS::EC2::Subnet, AWS::CloudTrail::Trail, AWS::EC2::Volume, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway
java.lang.String resourceId
sg-xxxxxx.java.lang.String relationshipName
java.lang.String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterValues
java.lang.String name
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String uniqueId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String description
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> objectIds
java.lang.Boolean evaluateExpressions
java.lang.String marker
HasMoreResults as True,
you can call DescribeObjects again and pass the marker value
from the response to retrieve the next set of results.
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineObjects
java.lang.String marker
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Boolean hasMoreResults
True, there are more pages of results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineIds
java.lang.String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String objectId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String expression
Constraints:
Length: 0 - 20971520
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String key
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String stringValue
Constraints:
Length: 0 - 10240
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String refValue
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String version
latest (default) and
active. Where latest indicates the last
definition saved to the pipeline and active indicates the
last definition of the pipeline that was activated.
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineObjects
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterObjects
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterValues
java.lang.String document
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String signature
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String marker
HasMoreResults as True, you
can call ListPipelines again and pass the marker value from the
response to retrieve the next set of results.
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineIdList
java.lang.String marker
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Boolean hasMoreResults
True, there are more results that can be obtained by a
subsequent call to ListPipelines.java.lang.String type
EQ), equal
reference (REF_EQ), less than or equal (LE),
greater than or equal (GE), or between
(BETWEEN). Equal reference (REF_EQ) can be
used only with reference fields. The other comparison types can be
used only with String fields. The comparison types you can use apply
only to certain object fields, as detailed below. The comparison operators EQ and REF_EQ act on the following fields:
The
comparison operators GE, LE, and
BETWEEN act on the following fields:
Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string "my".
Constraints:
Allowed Values: EQ, REF_EQ, LE, GE, BETWEEN
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
java.lang.String key
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String stringValue
Constraints:
Length: 0 - 10240
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String id
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String stringValue
Constraints:
Length: 0 - 10240
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String pipelineId
df-297EG78HU43EEXAMPLE.
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String name
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> fields
java.lang.String description
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String id
df-297EG78HU43EEXAMPLE.
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String name
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String id
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String name
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> fields
java.lang.String workerGroup
workerGroup in the call to PollForTask. There are
no wildcard values permitted in workerGroup, the string
must be an exact, case-sensitive, match.
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String hostname
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
InstanceIdentity instanceIdentity
http://169.254.169.254/latest/meta-data/instance-id, from
the EC2 instance. For more information, go to Instance
Metadata in the Amazon Elastic Compute Cloud User Guide.
Passing in this value proves that your task runner is running on an
EC2 instance, and ensures the proper AWS Data Pipeline service charges
are applied to your pipeline.TaskObject taskObject
java.lang.String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineObjects
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterObjects
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterValues
com.amazonaws.internal.ListWithAutoConstructFlag<T> validationErrors
pipelineObjects.com.amazonaws.internal.ListWithAutoConstructFlag<T> validationWarnings
pipelineObjects.java.lang.Boolean errored
True, there were validation errors. If errored is
True, the pipeline definition is stored but cannot be
activated until you correct the pipeline and call
PutPipelineDefinition to commit the corrected pipeline.java.lang.String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Query query
java.lang.String sphere
COMPONENT, INSTANCE,
ATTEMPT.
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String marker
HasMoreResults as True, you
can call QueryObjects again and pass the marker value from the
response to retrieve the next set of results.
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer limit
com.amazonaws.internal.ListWithAutoConstructFlag<T> ids
java.lang.String marker
HasMoreResults as True, you
can call QueryObjects again and pass the marker value from the
response to retrieve the next set of results.
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Boolean hasMoreResults
True, there are more results that can be obtained by a
subsequent call to QueryObjects.java.lang.String taskId
Constraints:
Length: 1 - 2048
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> fields
java.lang.Boolean canceled
True, the calling task runner should cancel processing
of the task. The task runner does not need to call
SetTaskStatus for canceled tasks.java.lang.String taskrunnerId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String workerGroup
workerGroup in the call to
ReportTaskRunnerHeartbeat. There are no wildcard values
permitted in workerGroup, the string must be an exact,
case-sensitive, match.
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String hostname
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Boolean terminate
True, the task runner that called
ReportTaskRunnerHeartbeat should terminate.java.lang.String fieldName
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Operator operator
java.lang.String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> objectIds
java.lang.String status
objectIds. For components, this can be either
PAUSE or RESUME. For instances, this can be
either CANCEL, RERUN, or
MARK_FINISHED.
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String taskId
Constraints:
Length: 1 - 2048
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String taskStatus
FINISHED, the task successfully completed. If
FAILED the task ended unsuccessfully. The
FALSE value is used by preconditions.
Constraints:
Allowed Values: FINISHED, FAILED, FALSE
java.lang.String errorId
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String errorMessage
java.lang.String errorStackTrace
Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String taskId
Constraints:
Length: 1 - 2048
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String attemptId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.util.Map<K,V> objects
java.lang.String pipelineId
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineObjects
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterObjects
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterValues
com.amazonaws.internal.ListWithAutoConstructFlag<T> validationErrors
com.amazonaws.internal.ListWithAutoConstructFlag<T> validationWarnings
java.lang.Boolean errored
True, there were validation errors.java.lang.String id
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> errors
java.lang.String id
Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> warnings
java.lang.String bandwidth
Example: 1Gbps
Default: None
java.lang.String connectionName
Example: "500M Connection to AWS"
Default: None
java.lang.String ownerAccount
Example: 123443215678
Default: None
java.lang.String interconnectId
Example: dxcon-456abc78
Default: None
java.lang.Integer vlan
Example: 101
Default: None
java.lang.String ownerAccount
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
java.lang.String connectionName
Example: "1G Connection to AWS"
Default: None
java.lang.String connectionState
Constraints:
Allowed Values: ordering, requested, pending, available, down, deleting, deleted, rejected
java.lang.String region
Example: us-east-1
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String bandwidth
Example: 1Gbps
Default: None
java.lang.Integer vlan
Example: 101
java.lang.String partnerName
java.lang.String connectionId
Default: None
java.lang.String ownerAccount
Default: None
NewPrivateVirtualInterfaceAllocation newPrivateVirtualInterfaceAllocation
Default: None
java.lang.String ownerAccount
java.lang.String virtualInterfaceId
Example: dxvif-123dfg56
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
java.lang.String virtualInterfaceType
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
java.lang.String virtualInterfaceName
Example: "My VPC"
java.lang.Integer vlan
Example: 101
java.lang.Integer asn
Example: 65000
java.lang.String authKey
Example: asdf34example
java.lang.String amazonAddress
Example: 192.168.1.1/30
java.lang.String customerAddress
Example: 192.168.1.2/30
java.lang.String virtualInterfaceState
Constraints:
Allowed Values: confirming, verifying, pending, available, deleting, deleted, rejected
java.lang.String customerRouterConfig
java.lang.String virtualGatewayId
Example: vgw-123er56
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeFilterPrefixes
java.lang.String connectionId
Default: None
java.lang.String ownerAccount
Default: None
NewPublicVirtualInterfaceAllocation newPublicVirtualInterfaceAllocation
Default: None
java.lang.String ownerAccount
java.lang.String virtualInterfaceId
Example: dxvif-123dfg56
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
java.lang.String virtualInterfaceType
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
java.lang.String virtualInterfaceName
Example: "My VPC"
java.lang.Integer vlan
Example: 101
java.lang.Integer asn
Example: 65000
java.lang.String authKey
Example: asdf34example
java.lang.String amazonAddress
Example: 192.168.1.1/30
java.lang.String customerAddress
Example: 192.168.1.2/30
java.lang.String virtualInterfaceState
Constraints:
Allowed Values: confirming, verifying, pending, available, deleting, deleted, rejected
java.lang.String customerRouterConfig
java.lang.String virtualGatewayId
Example: vgw-123er56
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeFilterPrefixes
java.lang.String connectionState
Constraints:
Allowed Values: ordering, requested, pending, available, down, deleting, deleted, rejected
java.lang.String virtualInterfaceId
Example: dxvif-123dfg56
Default: None
java.lang.String virtualGatewayId
A virtual private gateway can be managed via the Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.
Default: None
java.lang.String virtualInterfaceState
Constraints:
Allowed Values: confirming, verifying, pending, available, deleting, deleted, rejected
java.lang.String virtualInterfaceState
Constraints:
Allowed Values: confirming, verifying, pending, available, deleting, deleted, rejected
java.lang.String ownerAccount
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
java.lang.String connectionName
Example: "1G Connection to AWS"
Default: None
java.lang.String connectionState
Constraints:
Allowed Values: ordering, requested, pending, available, down, deleting, deleted, rejected
java.lang.String region
Example: us-east-1
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String bandwidth
Example: 1Gbps
Default: None
java.lang.Integer vlan
Example: 101
java.lang.String partnerName
java.lang.String location
Example: EqSV5
Default: None
java.lang.String bandwidth
Example: 1Gbps
Default: None
java.lang.String connectionName
Example: "1G Connection to AWS"
Default: None
java.lang.String ownerAccount
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
java.lang.String connectionName
Example: "1G Connection to AWS"
Default: None
java.lang.String connectionState
Constraints:
Allowed Values: ordering, requested, pending, available, down, deleting, deleted, rejected
java.lang.String region
Example: us-east-1
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String bandwidth
Example: 1Gbps
Default: None
java.lang.Integer vlan
Example: 101
java.lang.String partnerName
java.lang.String interconnectName
Example: "1G Interconnect to AWS"
Default: None
java.lang.String bandwidth
Example: 1Gbps
Default: None
Available values: 1Gbps,10Gbps
java.lang.String location
Example: EqSV5
Default: None
java.lang.String interconnectId
Example: dxcon-abc123
java.lang.String interconnectName
Example: "1G Interconnect to AWS"
java.lang.String interconnectState
Constraints:
Allowed Values: requested, pending, available, down, deleting, deleted
java.lang.String region
Example: us-east-1
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String bandwidth
Example: 1Gbps
Default: None
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
NewPrivateVirtualInterface newPrivateVirtualInterface
Default: None
java.lang.String ownerAccount
java.lang.String virtualInterfaceId
Example: dxvif-123dfg56
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
java.lang.String virtualInterfaceType
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
java.lang.String virtualInterfaceName
Example: "My VPC"
java.lang.Integer vlan
Example: 101
java.lang.Integer asn
Example: 65000
java.lang.String authKey
Example: asdf34example
java.lang.String amazonAddress
Example: 192.168.1.1/30
java.lang.String customerAddress
Example: 192.168.1.2/30
java.lang.String virtualInterfaceState
Constraints:
Allowed Values: confirming, verifying, pending, available, deleting, deleted, rejected
java.lang.String customerRouterConfig
java.lang.String virtualGatewayId
Example: vgw-123er56
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeFilterPrefixes
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
NewPublicVirtualInterface newPublicVirtualInterface
Default: None
java.lang.String ownerAccount
java.lang.String virtualInterfaceId
Example: dxvif-123dfg56
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
java.lang.String virtualInterfaceType
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
java.lang.String virtualInterfaceName
Example: "My VPC"
java.lang.Integer vlan
Example: 101
java.lang.Integer asn
Example: 65000
java.lang.String authKey
Example: asdf34example
java.lang.String amazonAddress
Example: 192.168.1.1/30
java.lang.String customerAddress
Example: 192.168.1.2/30
java.lang.String virtualInterfaceState
Constraints:
Allowed Values: confirming, verifying, pending, available, deleting, deleted, rejected
java.lang.String customerRouterConfig
java.lang.String virtualGatewayId
Example: vgw-123er56
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeFilterPrefixes
java.lang.String ownerAccount
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
java.lang.String connectionName
Example: "1G Connection to AWS"
Default: None
java.lang.String connectionState
Constraints:
Allowed Values: ordering, requested, pending, available, down, deleting, deleted, rejected
java.lang.String region
Example: us-east-1
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String bandwidth
Example: 1Gbps
Default: None
java.lang.Integer vlan
Example: 101
java.lang.String partnerName
java.lang.String interconnectState
Constraints:
Allowed Values: requested, pending, available, down, deleting, deleted
java.lang.String virtualInterfaceState
Constraints:
Allowed Values: confirming, verifying, pending, available, deleting, deleted, rejected
java.lang.String interconnectId
Example: dxcon-abc123
java.lang.String interconnectName
Example: "1G Interconnect to AWS"
java.lang.String interconnectState
Constraints:
Allowed Values: requested, pending, available, down, deleting, deleted
java.lang.String region
Example: us-east-1
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String bandwidth
Example: 1Gbps
Default: None
java.lang.String virtualInterfaceName
Example: "My VPC"
java.lang.Integer vlan
Example: 101
java.lang.Integer asn
Example: 65000
java.lang.String authKey
Example: asdf34example
java.lang.String amazonAddress
Example: 192.168.1.1/30
java.lang.String customerAddress
Example: 192.168.1.2/30
java.lang.String virtualGatewayId
Example: vgw-123er56
java.lang.String virtualInterfaceName
Example: "My VPC"
java.lang.Integer vlan
Example: 101
java.lang.Integer asn
Example: 65000
java.lang.String authKey
Example: asdf34example
java.lang.String amazonAddress
Example: 192.168.1.1/30
java.lang.String customerAddress
Example: 192.168.1.2/30
java.lang.String virtualInterfaceName
Example: "My VPC"
java.lang.Integer vlan
Example: 101
java.lang.Integer asn
Example: 65000
java.lang.String authKey
Example: asdf34example
java.lang.String amazonAddress
Example: 192.168.1.1/30
java.lang.String customerAddress
Example: 192.168.1.2/30
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeFilterPrefixes
java.lang.String virtualInterfaceName
Example: "My VPC"
java.lang.Integer vlan
Example: 101
java.lang.Integer asn
Example: 65000
java.lang.String authKey
Example: asdf34example
java.lang.String amazonAddress
Example: 192.168.1.1/30
java.lang.String customerAddress
Example: 192.168.1.2/30
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeFilterPrefixes
java.lang.String virtualGatewayId
Example: vgw-123er56
java.lang.String virtualGatewayState
java.lang.String ownerAccount
java.lang.String virtualInterfaceId
Example: dxvif-123dfg56
Default: None
java.lang.String location
Example: EqSV5
Default: None
java.lang.String connectionId
Example: dxcon-fg5678gh
Default: None
java.lang.String virtualInterfaceType
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
java.lang.String virtualInterfaceName
Example: "My VPC"
java.lang.Integer vlan
Example: 101
java.lang.Integer asn
Example: 65000
java.lang.String authKey
Example: asdf34example
java.lang.String amazonAddress
Example: 192.168.1.1/30
java.lang.String customerAddress
Example: 192.168.1.2/30
java.lang.String virtualInterfaceState
Constraints:
Allowed Values: confirming, verifying, pending, available, deleting, deleted, rejected
java.lang.String customerRouterConfig
java.lang.String virtualGatewayId
Example: vgw-123er56
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeFilterPrefixes
java.lang.String s
java.lang.String n
java.nio.ByteBuffer b
com.amazonaws.internal.ListWithAutoConstructFlag<T> sS
com.amazonaws.internal.ListWithAutoConstructFlag<T> nS
com.amazonaws.internal.ListWithAutoConstructFlag<T> bS
java.util.Map<K,V> m
com.amazonaws.internal.ListWithAutoConstructFlag<T> l
java.lang.Boolean nULL
java.lang.Boolean bOOL
AttributeValue value
Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.
java.lang.String action
PUT
(default), DELETE, and ADD. The behavior
depends on whether the specified primary key already exists in the
table. If an item with the specified Key is found in the table:
PUT - Adds the specified
attribute to the item. If the attribute already exists, it is replaced
by the new value.
DELETE - If no value is
specified, the attribute and its value are removed from the item. The
data type of the specified value must match the existing value's data
type.
If a set of values is specified, then those values are
subtracted from the old set. For example, if the attribute value was
the set [a,b,c] and the DELETE action specified
[a,c], then the final attribute value would be
[b]. Specifying an empty set is an error.
ADD - If the attribute does not already exist, then
the attribute and its values are added to the item. If the attribute
does exist, then the behavior of ADD depends on the data
type of the attribute:
If the existing attribute is a
number, and if Value is also a number, then the Value is
mathematically added to the existing attribute. If Value is a
negative number, then it is subtracted from the existing attribute.
If you use In addition, if you use
ADD to increment or decrement a
number value for an item that doesn't exist before the update,
DynamoDB uses 0 as the initial value. ADD to update an existing item, and intend to increment
or decrement an attribute value which does not yet exist, DynamoDB
uses 0 as the initial value. For example, suppose that
the item you want to update does not yet have an attribute named
itemcount, but you decide to ADD the number
3 to this attribute anyway, even though it currently does
not exist. DynamoDB will create the itemcount attribute, set
its initial value to 0, and finally add 3 to
it. The result will be a new itemcount attribute in the item,
with a value of 3.
If the existing
data type is a set, and if the Value is also a set, then the
Value is added to the existing set. (This is a set
operation, not mathematical addition.) For example, if the attribute
value was the set [1,2], and the ADD action
specified [3], then the final attribute value would be
[1,2,3]. An error occurs if an Add action is specified
for a set attribute and the attribute type specified does not match
the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid
for an existing attribute whose data type is number or is a set. Do
not use ADD for any other data types.
If no item with the specified Key is found:
PUT - DynamoDB creates a new item with the specified
primary key, and then adds the attribute.
DELETE - Nothing happens; there is no attribute to
delete.
ADD - DynamoDB creates an item with
the supplied primary key and number (or set of numbers) for the
attribute value. The only data types allowed are number and number
set; no other data types can be specified.
Constraints:
Allowed Values: ADD, PUT, DELETE
java.util.Map<K,V> requestItems
Each element in the map consists of the following:
Keys - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide all of the key attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
AttributesToGet - One or more attributes to be retrieved from the table. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
ConsistentRead - If
true, a strongly consistent read is used; if
false (the default), an eventually consistent read is
used.
Constraints:
Length: 1 - 100
java.lang.String returnConsumedCapacity
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
java.util.Map<K,V> responses
java.util.Map<K,V> unprocessedKeys
Each element consists of:
Keys - An array of primary key attribute values that define specific items in the table.
AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.
ConsistentRead - The consistency of a read
operation. If set to true, then a strongly consistent
read is used; otherwise, an eventually consistent read is used.
If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> consumedCapacity
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
java.util.Map<K,V> requestItems
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
Key - A map of primary key attribute values that uniquely identify the ! item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
Constraints:
Length: 1 - 25
java.lang.String returnConsumedCapacity
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
java.lang.String returnItemCollectionMetrics
SIZE, the response includes
statistics about item collections, if any, that were modified during
the operation are returned in the response. If set to
NONE (the default), no statistics are returned.
Constraints:
Allowed Values: SIZE, NONE
java.util.Map<K,V> unprocessedItems
Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest).
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.
Constraints:
Length: 1 - 25
java.util.Map<K,V> itemCollectionMetrics
Each entry consists of the following subelements:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
com.amazonaws.internal.ListWithAutoConstructFlag<T> consumedCapacity
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeValueList
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are
based on ASCII character code values. For example, a is
greater than A, and aa is greater than
B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
java.lang.String comparisonOperator
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL |
CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is supported for all
datatypes, including lists and maps.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
Binary, String Set, Number Set, or Binary Set. If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
NE : Not equal.
NE is supported for all datatypes, including lists and
maps.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
LE : Less than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can
contain only one AttributeValue of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue
element of a different type than the one specified in the request, the
value does not match. For example, {"S":"6"} does not
equal {"N":"6"}. Also, {"N":"6"} does not
compare to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
This operator tests for the
existence of an attribute, not its data type. If the data type of
attribute "NOT_NULL : The attribute
exists. NOT_NULL is supported for all datatypes,
including lists and maps. a" is null, and you evaluate it using
NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type
is not relevant to the NOT_NULL comparison operator.
This operator tests for the nonexistence of
an attribute, not its data type. If the data type of attribute
"NULL : The attribute does not
exist. NULL is supported for all datatypes, including
lists and maps. a" is null, and you evaluate it using NULL,
the result is a Boolean false. This is because the attribute
"a" exists; its data type is not relevant to the
NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a
set.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If the target attribute of the comparison is of type
String, then the operator checks for a substring match. If the target
attribute of the comparison is of type Binary, then the operator looks
for a subsequence of the target that matches the input. If the target
attribute of the comparison is a set ("SS",
"NS", or "BS"), then the operator evaluates
to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS
b", "a" can be a list; however, "b"
cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain
only one AttributeValue element of type String, Number, or
Binary (not a set type). If the target attribute of the comparison is
a String, then the operator checks for the absence of a substring
match. If the target attribute of the comparison is Binary, then the
operator checks for the absence of a subsequence of the target that
matches the input. If the target attribute of the comparison is a set
("SS", "NS", or "BS"), then the
operator evaluates to true if it does not find an exact match
with any member of the set.
NOT_CONTAINS is supported for lists:
When evaluating "a NOT CONTAINS b", "a" can
be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first
value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
Constraints:
Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.Double capacityUnits
Capacity table
java.util.Map<K,V> localSecondaryIndexes
java.util.Map<K,V> globalSecondaryIndexes
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeDefinitions
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
Each KeySchemaElement in the array is composed of:
AttributeName - The name of this key attribute.
KeyType - Determines whether the key attribute is
HASH or RANGE.
For a primary
key that consists of a hash attribute, you must specify exactly one
element with a KeyType of HASH.
For a primary
key that consists of hash and range attributes, you must specify
exactly two elements, in this order: The first element must have a
KeyType of HASH, and the second element must have
a KeyType of RANGE.
For more information, see Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
Constraints:
Length: 1 - 2
com.amazonaws.internal.ListWithAutoConstructFlag<T> localSecondaryIndexes
Each local secondary index in the array includes the following:
IndexName - The name of the local secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same hash key attribute as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY - Only the index and primary keys are
projected into the index.
INCLUDE - Only
the specified table attributes are projected into the index. The list
of projected attributes are in NonKeyAttributes.
ALL - All of the table attributes are projected into
the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
com.amazonaws.internal.ListWithAutoConstructFlag<T> globalSecondaryIndexes
IndexName - The name of the global secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the global secondary index.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY - Only the index
and primary keys are projected into the index.
INCLUDE - Only the specified table attributes are
projected into the index. The list of projected attributes are in
NonKeyAttributes.
ALL - All of the
table attributes are projected into the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
TableDescription tableDescription
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.Map<K,V> key
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
java.util.Map<K,V> expected
There is a newer parameter available. Use ConditionExpression instead. Note that if you use Expected and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A map of attribute/condition pairs. Expected provides a conditional block for the DeleteItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a is greater than
A, and aa is greater than B.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS |
NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal. EQ is supported for all datatypes, including
lists and maps.
AttributeValueList can contain only one
AttributeValue element of type String, Number, Binary, String
Set, Number Set, or Binary Set. If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
NE : Not equal.
NE is supported for all datatypes, including lists and
maps.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
LE : Less than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can
contain only one AttributeValue of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue
element of a different type than the one specified in the request, the
value does not match. For example, {"S":"6"} does not
equal {"N":"6"}. Also, {"N":"6"} does not
compare to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
This operator tests for the
existence of an attribute, not its data type. If the data type of
attribute "NOT_NULL : The attribute
exists. NOT_NULL is supported for all datatypes,
including lists and maps. a" is null, and you evaluate it using
NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type
is not relevant to the NOT_NULL comparison operator.
This operator tests for the nonexistence of
an attribute, not its data type. If the data type of attribute
"NULL : The attribute does not
exist. NULL is supported for all datatypes, including
lists and maps. a" is null, and you evaluate it using NULL,
the result is a Boolean false. This is because the attribute
"a" exists; its data type is not relevant to the
NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a
set.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If the target attribute of the comparison is of type
String, then the operator checks for a substring match. If the target
attribute of the comparison is of type Binary, then the operator looks
for a subsequence of the target that matches the input. If the target
attribute of the comparison is a set ("SS",
"NS", or "BS"), then the operator evaluates
to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS
b", "a" can be a list; however, "b"
cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain
only one AttributeValue element of type String, Number, or
Binary (not a set type). If the target attribute of the comparison is
a String, then the operator checks for the absence of a substring
match. If the target attribute of the comparison is Binary, then the
operator checks for the absence of a subsequence of the target that
matches the input. If the target attribute of the comparison is a set
("SS", "NS", or "BS"), then the
operator evaluates to true if it does not find an exact match
with any member of the set.
NOT_CONTAINS is supported for lists:
When evaluating "a NOT CONTAINS b", "a" can
be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first
value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true, DynamoDB will check to
see if that attribute value already exists in the table. If it is
found, then the condition evaluates to true; otherwise the condition
evaluate to false.
If Exists is
false, DynamoDB assumes that the attribute value does
not exist in the table. If in fact the value does not exist,
then the assumption is valid and the condition evaluates to true. If
the value is found, despite the assumption that it does not exist, the
condition evaluates to false.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
java.lang.String conditionalOperator
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the Expected map:
AND - If all of the
conditions evaluate to true, then the entire map evaluates to
true.
OR - If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
Constraints:
Allowed Values: AND, OR
java.lang.String returnValues
NONE - If ReturnValues is
not specified, or if its value is NONE, then nothing is
returned. (This setting is the default for ReturnValues.)
ALL_OLD - The content of the old item is
returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
java.lang.String returnConsumedCapacity
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
java.lang.String returnItemCollectionMetrics
SIZE, the response includes
statistics about item collections, if any, that were modified during
the operation are returned in the response. If set to
NONE (the default), no statistics are returned.
Constraints:
Allowed Values: SIZE, NONE
java.lang.String conditionExpression
An expression can contain any of the following:
Boolean functions: ATTRIBUTE_EXIST |
CONTAINS | BEGINS_WITH
Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: NOT | AND | OR
java.util.Map<K,V> expressionAttributeNames
To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
java.util.Map<K,V> expressionAttributeValues
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN
("Available","Backordered","Discontinued")
Now suppose that you specified the following for ExpressionAttributeValues:
{
"a":{"S":"Available"}, "b":{"S":"Backordered"},
"d":{"S":"Discontinued"} }
The expression can now be simplified as follows:
ProductStatus IN
(:a,:b,:c)
java.util.Map<K,V> attributes
ALL_OLD in the
request.ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
TableDescription tableDescription
TableDescription table
AttributeValue value
Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.
java.lang.Boolean exists
If Exists is true,
DynamoDB will check to see if that attribute value already exists in
the table. If it is found, then the operation succeeds. If it is not
found, the operation fails with a
ConditionalCheckFailedException.
If Exists
is false, DynamoDB assumes that the attribute value does
not exist in the table. If in fact the value does not exist, then the
assumption is valid and the operation succeeds. If the value is found,
despite the assumption that it does not exist, the operation fails
with a ConditionalCheckFailedException.
The
default setting for Exists is true. If you supply
a Value all by itself, DynamoDB assumes the attribute exists:
You don't have to set Exists to true, because it
is implied.
DynamoDB returns a ValidationException if:
Exists is true but there is no
Value to check. (You expect a value to exist, but don't specify
what that value is.)
Exists is false
but you also specify a Value. (You cannot expect an attribute
to have a value, while also expecting it not to exist.)
java.lang.String comparisonOperator
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS |
NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal. EQ is supported for all datatypes, including
lists and maps.
AttributeValueList can contain only one
AttributeValue element of type String, Number, Binary, String
Set, Number Set, or Binary Set. If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
NE : Not equal.
NE is supported for all datatypes, including lists and
maps.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
LE : Less than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can
contain only one AttributeValue of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue
element of a different type than the one specified in the request, the
value does not match. For example, {"S":"6"} does not
equal {"N":"6"}. Also, {"N":"6"} does not
compare to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
This operator tests for the
existence of an attribute, not its data type. If the data type of
attribute "NOT_NULL : The attribute
exists. NOT_NULL is supported for all datatypes,
including lists and maps. a" is null, and you evaluate it using
NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type
is not relevant to the NOT_NULL comparison operator.
This operator tests for the nonexistence of
an attribute, not its data type. If the data type of attribute
"NULL : The attribute does not
exist. NULL is supported for all datatypes, including
lists and maps. a" is null, and you evaluate it using NULL,
the result is a Boolean false. This is because the attribute
"a" exists; its data type is not relevant to the
NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a
set.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If the target attribute of the comparison is of type
String, then the operator checks for a substring match. If the target
attribute of the comparison is of type Binary, then the operator looks
for a subsequence of the target that matches the input. If the target
attribute of the comparison is a set ("SS",
"NS", or "BS"), then the operator evaluates
to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS
b", "a" can be a list; however, "b"
cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain
only one AttributeValue element of type String, Number, or
Binary (not a set type). If the target attribute of the comparison is
a String, then the operator checks for the absence of a substring
match. If the target attribute of the comparison is Binary, then the
operator checks for the absence of a subsequence of the target that
matches the input. If the target attribute of the comparison is a set
("SS", "NS", or "BS"), then the
operator evaluates to true if it does not find an exact match
with any member of the set.
NOT_CONTAINS is supported for lists:
When evaluating "a NOT CONTAINS b", "a" can
be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first
value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
Constraints:
Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeValueList
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are
based on ASCII character code values. For example, a is
greater than A, and aa is greater than
B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.Map<K,V> key
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
Constraints:
Length: 1 -
java.lang.Boolean consistentRead
true, then the operation uses
strongly consistent reads; otherwise, eventually consistent reads are
used.java.lang.String returnConsumedCapacity
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
java.lang.String projectionExpression
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
java.util.Map<K,V> expressionAttributeNames
To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
java.util.Map<K,V> item
ConsumedCapacity consumedCapacity
java.lang.String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
HASH or RANGE).
Constraints:
Length: 1 - 2
Projection projection
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
java.lang.String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
HASH
or RANGE).
Constraints:
Length: 1 - 2
Projection projection
java.lang.String indexStatus
CREATING - The index is being created, as the result of a CreateTable or UpdateTable operation.
UPDATING - The index is being updated, as the result of a CreateTable or UpdateTable operation.
DELETING - The index is being deleted, as the result of a DeleteTable operation.
ACTIVE - The index is ready for use.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
ProvisionedThroughputDescription provisionedThroughput
java.lang.Long indexSizeBytes
java.lang.Long itemCount
UpdateGlobalSecondaryIndexAction update
java.util.Map<K,V> itemCollectionKey
com.amazonaws.internal.ListWithAutoConstructFlag<T> sizeEstimateRangeGB
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
com.amazonaws.internal.ListWithAutoConstructFlag<T> keys
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
Constraints:
Length: 1 -
java.lang.Boolean consistentRead
true, then
a strongly consistent read is used; otherwise, an eventually
consistent read is used.java.lang.String projectionExpression
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
java.util.Map<K,V> expressionAttributeNames
To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
java.lang.String exclusiveStartTableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.Integer limit
Constraints:
Range: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> tableNames
If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results.
java.lang.String lastEvaluatedTableName
If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
HASH
or RANGE).
Constraints:
Length: 1 - 2
Projection projection
java.lang.String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
HASH or
RANGE).
Constraints:
Length: 1 - 2
Projection projection
java.lang.Long indexSizeBytes
java.lang.Long itemCount
java.lang.String projectionType
KEYS_ONLY - Only the index and primary keys are
projected into the index.
INCLUDE - Only
the specified table attributes are projected into the index. The list
of projected attributes are in NonKeyAttributes.
ALL - All of the table attributes are projected into
the index.
Constraints:
Allowed Values: ALL, KEYS_ONLY, INCLUDE
com.amazonaws.internal.ListWithAutoConstructFlag<T> nonKeyAttributes
For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
Constraints:
Length: 1 - 20
java.lang.Long readCapacityUnits
Constraints:
Range: 1 -
java.lang.Long writeCapacityUnits
Constraints:
Range: 1 -
java.util.Date lastIncreaseDateTime
java.util.Date lastDecreaseDateTime
java.lang.Long numberOfDecreasesToday
Constraints:
Range: 1 -
java.lang.Long readCapacityUnits
Constraints:
Range: 1 -
java.lang.Long writeCapacityUnits
Constraints:
Range: 1 -
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.Map<K,V> item
You must provide all of the attributes for the primary key. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item map is an AttributeValue object.
java.util.Map<K,V> expected
There is a newer parameter available. Use ConditionExpression instead. Note that if you use Expected and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A map of attribute/condition pairs. Expected provides a conditional block for the PutItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a is greater than
A, and aa is greater than B.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS |
NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal. EQ is supported for all datatypes, including
lists and maps.
AttributeValueList can contain only one
AttributeValue element of type String, Number, Binary, String
Set, Number Set, or Binary Set. If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
NE : Not equal.
NE is supported for all datatypes, including lists and
maps.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
LE : Less than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can
contain only one AttributeValue of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue
element of a different type than the one specified in the request, the
value does not match. For example, {"S":"6"} does not
equal {"N":"6"}. Also, {"N":"6"} does not
compare to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
This operator tests for the
existence of an attribute, not its data type. If the data type of
attribute "NOT_NULL : The attribute
exists. NOT_NULL is supported for all datatypes,
including lists and maps. a" is null, and you evaluate it using
NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type
is not relevant to the NOT_NULL comparison operator.
This operator tests for the nonexistence of
an attribute, not its data type. If the data type of attribute
"NULL : The attribute does not
exist. NULL is supported for all datatypes, including
lists and maps. a" is null, and you evaluate it using NULL,
the result is a Boolean false. This is because the attribute
"a" exists; its data type is not relevant to the
NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a
set.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If the target attribute of the comparison is of type
String, then the operator checks for a substring match. If the target
attribute of the comparison is of type Binary, then the operator looks
for a subsequence of the target that matches the input. If the target
attribute of the comparison is a set ("SS",
"NS", or "BS"), then the operator evaluates
to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS
b", "a" can be a list; however, "b"
cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain
only one AttributeValue element of type String, Number, or
Binary (not a set type). If the target attribute of the comparison is
a String, then the operator checks for the absence of a substring
match. If the target attribute of the comparison is Binary, then the
operator checks for the absence of a subsequence of the target that
matches the input. If the target attribute of the comparison is a set
("SS", "NS", or "BS"), then the
operator evaluates to true if it does not find an exact match
with any member of the set.
NOT_CONTAINS is supported for lists:
When evaluating "a NOT CONTAINS b", "a" can
be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first
value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true, DynamoDB will check to
see if that attribute value already exists in the table. If it is
found, then the condition evaluates to true; otherwise the condition
evaluate to false.
If Exists is
false, DynamoDB assumes that the attribute value does
not exist in the table. If in fact the value does not exist,
then the assumption is valid and the condition evaluates to true. If
the value is found, despite the assumption that it does not exist, the
condition evaluates to false.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
java.lang.String returnValues
NONE -
If ReturnValues is not specified, or if its value is
NONE, then nothing is returned. (This setting is the
default for ReturnValues.)
ALL_OLD -
If PutItem overwrote an attribute name-value pair, then the
content of the old item is returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
java.lang.String returnConsumedCapacity
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
java.lang.String returnItemCollectionMetrics
SIZE, the response includes
statistics about item collections, if any, that were modified during
the operation are returned in the response. If set to
NONE (the default), no statistics are returned.
Constraints:
Allowed Values: SIZE, NONE
java.lang.String conditionalOperator
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the Expected map:
AND - If all of the
conditions evaluate to true, then the entire map evaluates to
true.
OR - If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
Constraints:
Allowed Values: AND, OR
java.lang.String conditionExpression
An expression can contain any of the following:
Boolean functions:
ATTRIBUTE_EXIST | CONTAINS | BEGINS_WITH
Comparison operators: = | <> | < | > | <= | >= | BETWEEN |
IN
Logical operators: NOT | AND | OR
java.util.Map<K,V> expressionAttributeNames
To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
java.util.Map<K,V> expressionAttributeValues
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN
("Available","Backordered","Discontinued")
Now suppose that you specified the following for ExpressionAttributeValues:
{
"a":{"S":"Available"}, "b":{"S":"Backordered"},
"d":{"S":"Discontinued"} }
The expression can now be simplified as follows:
ProductStatus IN
(:a,:b,:c)
java.util.Map<K,V> attributes
ALL_OLD in the request. Each element consists of an
attribute name and an attribute value.ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
java.util.Map<K,V> item
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.lang.String select
ALL_ATTRIBUTES - Returns all of
the item attributes from the specified table or index. If you query a
local secondary index, then for each matching item in the index
DynamoDB will fetch the entire item from the parent table. If the
index is configured to project all item attributes, then all of the
data can be obtained from the local secondary index, and no fetching
is required.
ALL_PROJECTED_ATTRIBUTES -
Allowed only when querying an index. Retrieves all attributes that
have been projected into the index. If the index is configured to
project all attributes, this return value is equivalent to specifying
ALL_ATTRIBUTES.
COUNT -
Returns the number of matching items, rather than the matching items
themselves.
SPECIFIC_ATTRIBUTES - Returns
only the attributes listed in AttributesToGet. This return
value is equivalent to specifying AttributesToGet without
specifying any value for Select.
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select nor AttributesToGet are
specified, DynamoDB defaults to ALL_ATTRIBUTES when
accessing a table, and ALL_PROJECTED_ATTRIBUTES when
accessing an index. You cannot use both Select and
AttributesToGet together in a single request, unless the value
for Select is SPECIFIC_ATTRIBUTES. (This usage is
equivalent to specifying AttributesToGet without any value for
Select.)
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both
AttributesToGet and Select together in a Query
request, unless the value for Select is
SPECIFIC_ATTRIBUTES. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
Constraints:
Length: 1 -
java.lang.Integer limit
Constraints:
Range: 1 -
java.lang.Boolean consistentRead
true, then the operation uses
strongly consistent reads; otherwise, eventually consistent reads are
used. Strongly consistent reads are not supported on global
secondary indexes. If you query a global secondary index with
ConsistentRead set to true, you will receive an
error message.
java.util.Map<K,V> keyConditions
EQ
condition. You can optionally specify a second condition, referring to
the range key attribute. For a query on an index, you can have conditions only on the index key attributes. You must specify the index hash attribute name and value as an EQ condition. You can optionally specify a second condition, referring to the index key range attribute.
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than,
equals, or less than are based on ASCII character code values. For
example, a is greater than A, and
aa is greater than B. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT |
GE | GT | BEGINS_WITH | BETWEEN
The following are descriptions of these comparison operators.
EQ : Equal.
AttributeValueList can contain
only one AttributeValue of type String, Number, or Binary (not
a set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not equal
{"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList
can contain only one AttributeValue element of type String,
Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
LT : Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
BEGINS_WITH : Checks for
a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
BETWEEN : Greater than or equal to the first value,
and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
java.util.Map<K,V> queryFilter
There is a newer parameter available. Use FilterExpression instead. Note that if you use QueryFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A condition that evaluates the query results and returns only the desired values.
If you specify more than one condition in the QueryFilter
map, then by default all of the conditions must evaluate to true. In
other words, the conditions are ANDed together. (You can use the
ConditionalOperator parameter to OR the conditions instead. If
you do this, then at least one of the conditions must evaluate to
true, rather than all of them.) QueryFilter does not
allow key attrbutes. You cannot define a filter condition on a hash
key or range key.
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.
For type Number, value comparisons are numeric.
String value comparisons for
greater than, equals, or less than are based on ASCII character code
values. For example, a is greater than A,
and aa is greater than B. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see API_Condition.html.
java.lang.String conditionalOperator
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the QueryFilter map:
AND - If all of the
conditions evaluate to true, then the entire map evaluates to
true.
OR - If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
Constraints:
Allowed Values: AND, OR
java.lang.Boolean scanIndexForward
If ScanIndexForward is not specified, the results are returned in ascending order.
java.util.Map<K,V> exclusiveStartKey
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
java.lang.String returnConsumedCapacity
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
java.lang.String projectionExpression
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
java.lang.String filterExpression
The condition you specify is applied to the items queried; any items that do not match the expression are not returned.
java.util.Map<K,V> expressionAttributeNames
To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
java.util.Map<K,V> expressionAttributeValues
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN
("Available","Backordered","Discontinued")
Now suppose that you specified the following for ExpressionAttributeValues:
{
"a":{"S":"Available"}, "b":{"S":"Backordered"},
"d":{"S":"Discontinued"} }
The expression can now be simplified as follows:
ProductStatus IN
(:a,:b,:c)
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
java.lang.Integer count
If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before> the filter was applied.
If you did not use a filter in the request, then Count and ScannedCount are the same.
java.lang.Integer scannedCount
If you did not use a filter in the request, then ScannedCount is the same as Count.
java.util.Map<K,V> lastEvaluatedKey
If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.
ConsumedCapacity consumedCapacity
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve lists or maps; however, it cannot retrieve individual list or map elements.
The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
Constraints:
Length: 1 -
java.lang.Integer limit
Constraints:
Range: 1 -
java.lang.String select
ALL_ATTRIBUTES - Returns all of the item
attributes.
COUNT - Returns the number of
matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES - Returns only the attributes
listed in AttributesToGet. This return value is equivalent to
specifying AttributesToGet without specifying any value for
Select.
If neither Select nor
AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES. You cannot use both
AttributesToGet and Select together in a single request,
unless the value for Select is
SPECIFIC_ATTRIBUTES. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
java.util.Map<K,V> scanFilter
There is a newer parameter available. Use FilterExpression instead. Note that if you use ScanFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A condition that evaluates the scan results and returns only the desired values.
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a is greater than
A, and aa is greater than B.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see Condition.
java.lang.String conditionalOperator
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the ScanFilter map:
AND - If all of
the conditions evaluate to true, then the entire map evaluates to
true.
OR - If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
Constraints:
Allowed Values: AND, OR
java.util.Map<K,V> exclusiveStartKey
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
java.lang.String returnConsumedCapacity
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
java.lang.Integer totalSegments
The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
Constraints:
Range: 1 - 1000000
java.lang.Integer segment
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you specify Segment, you must also specify TotalSegments.
Constraints:
Range: 0 - 999999
java.lang.String projectionExpression
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
java.lang.String filterExpression
The condition you specify is applied to the items scanned; any items that do not match the expression are not returned.
java.util.Map<K,V> expressionAttributeNames
To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
java.util.Map<K,V> expressionAttributeValues
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN
("Available","Backordered","Discontinued")
Now suppose that you specified the following for ExpressionAttributeValues:
{
"a":{"S":"Available"}, "b":{"S":"Backordered"},
"d":{"S":"Discontinued"} }
The expression can now be simplified as follows:
ProductStatus IN
(:a,:b,:c)
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
java.lang.Integer count
If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.
If you did not use a filter in the request, then Count is the same as ScannedCount.
java.lang.Integer scannedCount
If you did not use a filter in the request, then ScannedCount is the same as Count.
java.util.Map<K,V> lastEvaluatedKey
If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.
ConsumedCapacity consumedCapacity
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeDefinitions
Each AttributeDefinition object in this array is composed of:
AttributeName - The name of the attribute.
AttributeType - The data type for the attribute.
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
AttributeName - The name of the attribute.
KeyType - The key type for the
attribute. Can be either HASH or RANGE.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Constraints:
Length: 1 - 2
java.lang.String tableStatus
CREATING - The table is being created, as the result of a CreateTable operation.
UPDATING - The table is being updated, as the result of an UpdateTable operation.
DELETING - The table is being deleted, as the result of a DeleteTable operation.
ACTIVE - The table is ready for use.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
java.util.Date creationDateTime
ProvisionedThroughputDescription provisionedThroughput
java.lang.Long tableSizeBytes
java.lang.Long itemCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> localSecondaryIndexes
IndexName - The name of the local secondary index.
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY - Only the index and primary keys are
projected into the index.
INCLUDE - Only
the specified table attributes are projected into the index. The list
of projected attributes are in NonKeyAttributes.
ALL - All of the table attributes are projected into
the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the
DELETING state, no information about indexes will be
returned.
com.amazonaws.internal.ListWithAutoConstructFlag<T> globalSecondaryIndexes
IndexName - The name of the global secondary index.
IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexStatus - The current status of the global secondary index:
CREATING - The index is being created.
UPDATING - The index is being updated.
DELETING - The index is being deleted.
ACTIVE - The index is ready for use.
ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same hash key attribute as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
ProjectionType - One of the following:
KEYS_ONLY - Only the index
and primary keys are projected into the index.
INCLUDE - Only the specified table attributes are
projected into the index. The list of projected attributes are in
NonKeyAttributes.
ALL - All of the
table attributes are projected into the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the DELETING state, no information
about indexes will be returned.
java.lang.String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
java.util.Map<K,V> key
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
java.util.Map<K,V> attributeUpdates
There is a newer parameter available. Use UpdateExpression instead. Note that if you use AttributeUpdates and UpdateExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements.
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any nonkey attributes.
Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
Value - The new value, if applicable, for this attribute.
Action - A value that specifies how to perform
the update. This action is only valid for an existing attribute whose
data type is Number or is a set; do not use ADD for other
data types.
If an item with the specified primary key is found in the table, the following values perform the following actions:
PUT - Adds the specified attribute to the item.
If the attribute already exists, it is replaced by the new value.
DELETE - Removes the attribute and its
value, if no value is specified for DELETE. The data type
of the specified value must match the existing value's data type.
If a set of values is specified, then those values are subtracted
from the old set. For example, if the attribute value was the set
[a,b,c] and the DELETE action specifies
[a,c], then the final attribute value is
[b]. Specifying an empty set is an error.
ADD - Adds the specified value to the item, if the
attribute does not already exist. If the attribute does exist, then
the behavior of ADD depends on the data type of the
attribute:
If the existing attribute is a number, and if
Value is also a number, then Value is mathematically
added to the existing attribute. If Value is a negative number,
then it is subtracted from the existing attribute. If you
use Similarly, if you use ADD to increment or decrement a number value for an
item that doesn't exist before the update, DynamoDB uses 0 as the
initial value. ADD for an
existing item to increment or decrement an attribute value that
doesn't exist before the update, DynamoDB uses 0 as the
initial value. For example, suppose that the item you want to update
doesn't have an attribute named itemcount, but you decide to
ADD the number 3 to this attribute anyway.
DynamoDB will create the itemcount attribute, set its initial
value to 0, and finally add 3 to it. The
result will be a new itemcount attribute, with a value of
3.
If the existing data type is a
set, and if Value is also a set, then Value is appended
to the existing set. For example, if the attribute value is the set
[1,2], and the ADD action specified
[3], then the final attribute value is
[1,2,3]. An error occurs if an ADD action is
specified for a set attribute and the attribute type specified does
not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, Value must also be a set of strings.
If no item with the specified key is found in the table, the following values perform the following actions:
PUT - Causes DynamoDB to create a new item with the
specified primary key, and then adds the attribute.
DELETE - Causes nothing to happen; there is no
attribute to delete.
ADD - Causes DynamoDB
to creat an item with the supplied primary key and number (or set of
numbers) for the attribute value. The only data types allowed are
Number and Number Set.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
java.util.Map<K,V> expected
There is a newer parameter available. Use ConditionExpression instead. Note that if you use Expected and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a is greater than
A, and aa is greater than B.
For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS |
NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal. EQ is supported for all datatypes, including
lists and maps.
AttributeValueList can contain only one
AttributeValue element of type String, Number, Binary, String
Set, Number Set, or Binary Set. If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
NE : Not equal.
NE is supported for all datatypes, including lists and
maps.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
LE : Less than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can
contain only one AttributeValue of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue
element of a different type than the one specified in the request, the
value does not match. For example, {"S":"6"} does not
equal {"N":"6"}. Also, {"N":"6"} does not
compare to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
This operator tests for the
existence of an attribute, not its data type. If the data type of
attribute "NOT_NULL : The attribute
exists. NOT_NULL is supported for all datatypes,
including lists and maps. a" is null, and you evaluate it using
NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type
is not relevant to the NOT_NULL comparison operator.
This operator tests for the nonexistence of
an attribute, not its data type. If the data type of attribute
"NULL : The attribute does not
exist. NULL is supported for all datatypes, including
lists and maps. a" is null, and you evaluate it using NULL,
the result is a Boolean false. This is because the attribute
"a" exists; its data type is not relevant to the
NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a
set.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If the target attribute of the comparison is of type
String, then the operator checks for a substring match. If the target
attribute of the comparison is of type Binary, then the operator looks
for a subsequence of the target that matches the input. If the target
attribute of the comparison is a set ("SS",
"NS", or "BS"), then the operator evaluates
to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS
b", "a" can be a list; however, "b"
cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain
only one AttributeValue element of type String, Number, or
Binary (not a set type). If the target attribute of the comparison is
a String, then the operator checks for the absence of a substring
match. If the target attribute of the comparison is Binary, then the
operator checks for the absence of a subsequence of the target that
matches the input. If the target attribute of the comparison is a set
("SS", "NS", or "BS"), then the
operator evaluates to true if it does not find an exact match
with any member of the set.
NOT_CONTAINS is supported for lists:
When evaluating "a NOT CONTAINS b", "a" can
be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first
value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true, DynamoDB will check to
see if that attribute value already exists in the table. If it is
found, then the condition evaluates to true; otherwise the condition
evaluate to false.
If Exists is
false, DynamoDB assumes that the attribute value does
not exist in the table. If in fact the value does not exist,
then the assumption is valid and the condition evaluates to true. If
the value is found, despite the assumption that it does not exist, the
condition evaluates to false.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
java.lang.String conditionalOperator
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter does not support lists or maps.
A logical operator to apply to the conditions in the Expected map:
AND - If all of the
conditions evaluate to true, then the entire map evaluates to
true.
OR - If at least one of the conditions
evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is
the default.
The operation will succeed only if the entire map evaluates to true.
Constraints:
Allowed Values: AND, OR
java.lang.String returnValues
NONE - If ReturnValues is not specified, or if
its value is NONE, then nothing is returned. (This
setting is the default for ReturnValues.)
ALL_OLD - If UpdateItem overwrote an attribute
name-value pair, then the content of the old item is returned.
UPDATED_OLD - The old versions of only the
updated attributes are returned.
ALL_NEW -
All of the attributes of the new version of the item are returned.
UPDATED_NEW - The new versions of only the
updated attributes are returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
java.lang.String returnConsumedCapacity
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
java.lang.String returnItemCollectionMetrics
SIZE, the response includes
statistics about item collections, if any, that were modified during
the operation are returned in the response. If set to
NONE (the default), no statistics are returned.
Constraints:
Allowed Values: SIZE, NONE
java.lang.String updateExpression
The following action values are available for UpdateExpression.
SET - Adds one or more attributes and values
to an item. If any of these attribute already exist, they are replaced
by the new values. You can also use SET to add or
subtract from an attribute that is of type Number.
SET
supports the following functions:
if_not_exists
(path, operand) - if the item does not contain an attribute at
the specified path, then if_not_exists evaluates to
operand; otherwise, it evaluates to path. You can use this function to
avoid overwriting an attribute that may already be present in the
item.
list_append (operand, operand) -
evaluates to a list with a new element added to it. You can append the
new element to the start or the end of the list by reversing the order
of the operands.
These function names are case-sensitive.
REMOVE - Removes one or
more attributes from an item.
ADD - Adds
the specified value to the item, if the attribute does not already
exist. If the attribute does exist, then the behavior of
ADD depends on the data type of the attribute:
If the existing attribute is a number, and if Value is also
a number, then Value is mathematically added to the existing
attribute. If Value is a negative number, then it is subtracted
from the existing attribute. If you use Similarly, if you use ADD to
increment or decrement a number value for an item that doesn't exist
before the update, DynamoDB uses 0 as the initial value.
ADD for an existing item to
increment or decrement an attribute value that doesn't exist before
the update, DynamoDB uses 0 as the initial value. For
example, suppose that the item you want to update doesn't have an
attribute named itemcount, but you decide to ADD
the number 3 to this attribute anyway. DynamoDB will
create the itemcount attribute, set its initial value to
0, and finally add 3 to it. The result will
be a new itemcount attribute in the item, with a value of
3.
If the existing data type is a
set and if Value is also a set, then Value is added to
the existing set. For example, if the attribute value is the set
[1,2], and the ADD action specified
[3], then the final attribute value is
[1,2,3]. An error occurs if an ADD action is
specified for a set attribute and the attribute type specified does
not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
The ADD action only supports Number
and set data types. In addition, ADD can only be used on
top-level attributes, not nested attributes.
DELETE - Deletes an element from a set.
If a set of
values is specified, then those values are subtracted from the old
set. For example, if the attribute value was the set
The [a,b,c] and the DELETE action specifies
[a,c], then the final attribute value is
[b]. Specifying an empty set is an error.
DELETE action only supports Number and
set data types. In addition, DELETE can only be used on
top-level attributes, not nested attributes.
You can have many actions in a single expression, such as the
following: SET a=:value1, b=:value2 DELETE :value3, :value4,
:value5
An expression can contain any of the following:
Boolean functions: ATTRIBUTE_EXIST | CONTAINS |
BEGINS_WITH
Comparison operators: = | <>
| < | > | <= | >= | BETWEEN | IN
Logical
operators: NOT | AND | OR
java.lang.String conditionExpression
An expression can contain any of the following:
Boolean functions: ATTRIBUTE_EXIST | CONTAINS |
BEGINS_WITH
Comparison operators: = | <> |
< | > | <= | >= | BETWEEN | IN
Logical operators:
NOT | AND | OR
java.util.Map<K,V> expressionAttributeNames
To shorten an attribute name that is very long or unwieldy in an expression.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following expression:
order.customerInfo.LastName = "Smith" OR
order.customerInfo.LastName = "Jones"
Now suppose that you specified the following for ExpressionAttributeNames:
{"n":"order.customerInfo.LastName"}
The expression can now be simplified as follows:
#n = "Smith" OR #n = "Jones"
java.util.Map<K,V> expressionAttributeValues
Use the : character in an expression to dereference an attribute value. For example, consider the following expression:
ProductStatus IN
("Available","Backordered","Discontinued")
Now suppose that you specified the following for ExpressionAttributeValues:
{
"a":{"S":"Available"}, "b":{"S":"Backordered"},
"d":{"S":"Discontinued"} }
The expression can now be simplified as follows:
ProductStatus IN
(:a,:b,:c)
java.util.Map<K,V> attributes
NONE in the request. Each element represents one
attribute.ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
java.lang.String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> globalSecondaryIndexUpdates
TableDescription tableDescription
PutRequest putRequest
DeleteRequest deleteRequest
VpcPeeringConnection vpcPeeringConnection
java.lang.String instanceId
java.lang.String publicIp
java.lang.String allocationId
java.lang.String associationId
java.lang.String domain
standard) or instances in a VPC
(vpc).
Constraints:
Allowed Values: vpc, standard
java.lang.String networkInterfaceId
java.lang.String networkInterfaceOwnerId
java.lang.String privateIpAddress
java.lang.String publicIp
java.lang.String domain
standard) or instances in a VPC
(vpc).
Constraints:
Allowed Values: vpc, standard
java.lang.String allocationId
java.lang.String networkInterfaceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
java.lang.Integer secondaryPrivateIpAddressCount
java.lang.Boolean allowReassignment
java.lang.String instanceId
java.lang.String publicIp
java.lang.String allocationId
java.lang.String networkInterfaceId
java.lang.String privateIpAddress
java.lang.Boolean allowReassociation
Default: false
java.lang.String instanceId
java.lang.String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
java.lang.String volumeId
java.lang.String instanceId
java.lang.String device
/dev/sdh or xvdh).VolumeAttachment attachment
VpcAttachment vpcAttachment
java.lang.String groupId
java.lang.String sourceSecurityGroupName
java.lang.String sourceSecurityGroupOwnerId
java.lang.String ipProtocol
java.lang.Integer fromPort
-1 to specify all
ICMP types.java.lang.Integer toPort
-1 to specify all
ICMP codes for the ICMP type.java.lang.String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
java.lang.String groupName
java.lang.String groupId
java.lang.String sourceSecurityGroupName
java.lang.String sourceSecurityGroupOwnerId
java.lang.String ipProtocol
java.lang.Integer fromPort
-1 to specify all
ICMP types.java.lang.Integer toPort
-1 to specify all
ICMP codes for the ICMP type.java.lang.String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
java.lang.String zoneName
java.lang.String state
available |
impaired | unavailable).
Constraints:
Allowed Values: available
java.lang.String regionName
com.amazonaws.internal.ListWithAutoConstructFlag<T> messages
java.lang.String virtualName
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
java.lang.String deviceName
/dev/sdh).EbsBlockDevice ebs
java.lang.String noDevice
java.lang.String instanceId
Type: String
Default: None
Required: Yes
Storage storage
BundleTask bundleTask
java.lang.String instanceId
java.lang.String bundleId
java.lang.String state
Constraints:
Allowed Values: pending, waiting-for-shutdown, bundling, storing, cancelling, complete, failed
java.util.Date startTime
java.util.Date updateTime
Storage storage
java.lang.String progress
BundleTaskError bundleTaskError
BundleTask bundleTask
java.lang.String instanceId
java.lang.String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String conversionTaskId
java.lang.String expirationTime
ImportInstanceTaskDetails importInstance
ImportVolumeTaskDetails importVolume
java.lang.String state
Constraints:
Allowed Values: active, cancelling, cancelled, completed
java.lang.String statusMessage
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String sourceRegion
java.lang.String sourceImageId
java.lang.String name
java.lang.String description
java.lang.String clientToken
java.lang.String sourceRegion
java.lang.String sourceSnapshotId
java.lang.String description
java.lang.String destinationRegion
PresignedUrl.java.lang.String presignedUrl
PresignedUrl should use
the snapshot source endpoint, the CopySnapshot action,
and include the SourceRegion,
SourceSnapshotId, and DestinationRegion
parameters. The PresignedUrl must be signed using AWS
Signature Version 4. Because Amazon EBS snapshots are stored in Amazon
S3, the signing algorithm for this parameter uses the same logic that
is described in Authenticating
Requests by Using Query Parameters (AWS Signature Version 4) in
the Amazon Simple Storage Service API Reference. An invalid or
improperly signed PresignedUrl will cause the copy
operation to fail asynchronously, and the snapshot will move to an
error state.java.lang.String type
ipsec.1).
Constraints:
Allowed Values: ipsec.1
java.lang.String publicIp
java.lang.Integer bgpAsn
Default: 65000
CustomerGateway customerGateway
DhcpOptions dhcpOptions
java.lang.String instanceId
java.lang.String name
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
java.lang.String description
java.lang.Boolean noReboot
false, which means
Amazon EC2 attempts to shut down the instance cleanly before image
creation and then reboots the instance. When the parameter is set to
true, Amazon EC2 doesn't shut down the instance before
creating the image. When this option is used, file system integrity on
the created image can't be guaranteed.com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
java.lang.String description
java.lang.String instanceId
java.lang.String targetEnvironment
Constraints:
Allowed Values: citrix, vmware, microsoft
ExportToS3TaskSpecification exportToS3Task
ExportTask exportTask
InternetGateway internetGateway
KeyPair keyPair
java.lang.String networkAclId
java.lang.Integer ruleNumber
Constraints: Positive integer from 1 to 32766
java.lang.String protocol
java.lang.String ruleAction
Constraints:
Allowed Values: allow, deny
java.lang.Boolean egress
java.lang.String cidrBlock
172.16.0.0/24).IcmpTypeCode icmpTypeCode
PortRange portRange
NetworkAcl networkAcl
java.lang.String subnetId
java.lang.String description
java.lang.String privateIpAddress
privateIpAddresses as primary
(only one IP address can be designated as primary).com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
java.lang.Integer secondaryPrivateIpAddressCount
privateIpAddresses. The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide.
NetworkInterface networkInterface
java.lang.String reservedInstancesId
java.lang.Integer instanceCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> priceSchedules
java.lang.String clientToken
java.lang.String routeTableId
java.lang.String destinationCidrBlock
java.lang.String gatewayId
java.lang.String instanceId
java.lang.String networkInterfaceId
java.lang.String vpcPeeringConnectionId
RouteTable routeTable
java.lang.String groupName
Constraints: Up to 255 characters in length
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
java.lang.String description
Constraints: Up to 255 characters in length
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
java.lang.String vpcId
Snapshot snapshot
SpotDatafeedSubscription spotDatafeedSubscription
java.lang.String vpcId
java.lang.String cidrBlock
10.0.0.0/24.java.lang.String availabilityZone
Default: Amazon EC2 selects one for you (recommended).
Subnet subnet
com.amazonaws.internal.ListWithAutoConstructFlag<T> resources
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
value parameter is required, but if
you don't want the tag to have a value, specify the parameter with no
value, and we set the value to an empty string.java.lang.String userId
java.lang.String group
Constraints:
Allowed Values: all
com.amazonaws.internal.ListWithAutoConstructFlag<T> add
com.amazonaws.internal.ListWithAutoConstructFlag<T> remove
java.lang.Integer size
Constraints: If the volume type is
io1, the minimum size of the volume is 4 GiB.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
java.lang.String snapshotId
java.lang.String availabilityZone
java.lang.String volumeType
gp2 for General Purpose
(SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or
standard for Magnetic volumes. Default:
standard
Constraints:
Allowed Values: standard, io1, gp2
java.lang.Integer iops
java.lang.Boolean encrypted
java.lang.String kmsKeyId
arn:aws:kms namespace, followed by the region of the
master key, the AWS account ID of the master key owner, the
key namespace, and then the master key ID. For example,
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.Volume volume
java.lang.String vpcId
java.lang.String peerVpcId
java.lang.String peerOwnerId
Default: Your AWS account ID
VpcPeeringConnection vpcPeeringConnection
java.lang.String cidrBlock
10.0.0.0/16.java.lang.String instanceTenancy
default means that instances can be launched
with any tenancy; a value of dedicated means all
instances launched into the VPC are launched as dedicated tenancy
instances regardless of the tenancy assigned to the instance at
launch. Dedicated tenancy instances run on single-tenant hardware.
Default: default
Constraints:
Allowed Values: default, dedicated
Vpc vpc
java.lang.String type
ipsec.1).java.lang.String customerGatewayId
java.lang.String vpnGatewayId
VpnConnectionOptionsSpecification options
true. Default: false
VpnConnection vpnConnection
VpnGateway vpnGateway
java.lang.String customerGatewayId
java.lang.String state
pending | available |
deleting | deleted).java.lang.String type
ipsec.1).java.lang.String ipAddress
java.lang.String bgpAsn
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> resources
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
value
parameter, we delete the tag regardless of its value. If you specify
this parameter with an empty string as the value, we delete the key
only if its value is an empty string.com.amazonaws.internal.ListWithAutoConstructFlag<T> publicIps
Default: Describes all your Elastic IP addresses.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
allocation-id - [EC2-VPC] The allocation ID for
the address.
association-id - [EC2-VPC] The
association ID for the address.
domain -
Indicates whether the address is for use in EC2-Classic
(standard) or in a VPC (vpc).
instance-id - The ID of the instance the address is
associated with, if any.
network-interface-id - [EC2-VPC] The ID of the network
interface that the address is associated with, if any.
network-interface-owner-id - The AWS account ID of the
owner.
private-ip-address - [EC2-VPC] The
private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address.
com.amazonaws.internal.ListWithAutoConstructFlag<T> allocationIds
Default: Describes all your Elastic IP addresses.
com.amazonaws.internal.ListWithAutoConstructFlag<T> zoneNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
message - Information
about the Availability Zone.
region-name -
The name of the region for the Availability Zone (for example,
us-east-1).
state - The state
of the Availability Zone (available |
impaired | unavailable).
zone-name - The name of the Availability Zone (for
example, us-east-1a).
com.amazonaws.internal.ListWithAutoConstructFlag<T> bundleIds
Default: Describes all your bundle tasks.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
bundle-id - The ID of
the bundle task.
error-code - If the task
failed, the error code returned.
error-message - If the task failed, the error message
returned.
instance-id - The ID of the
instance.
progress - The level of task
completion, as a percentage (for example, 20%).
s3-bucket - The Amazon S3 bucket to store the AMI.
s3-prefix - The beginning of the AMI name.
start-time - The time the task started (for
example, 2013-09-15T17:15:20.000Z).
state -
The state of the task (pending |
waiting-for-shutdown | bundling |
storing | cancelling | complete
| failed).
update-time - The
time of the most recent update for the task.
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
group-id - The ID of a
VPC security group that's associated with the instance.
instance-id - The ID of the instance.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id - The ID of the VPC that the
instance is linked to.
java.lang.String nextToken
java.lang.Integer maxResults
Constraint: If the value is greater than 1000, we return only 1000 items.
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> customerGatewayIds
Default: Describes all your customer gateways.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
bgp-asn - The customer
gateway's Border Gateway Protocol (BGP) Autonomous System Number
(ASN).
customer-gateway-id - The ID of the
customer gateway.
ip-address - The IP
address of the customer gateway's Internet-routable external
interface.
state - The state of the
customer gateway (pending | available |
deleting | deleted).
type - The type of customer gateway. Currently, the
only supported type is ipsec.1.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpOptionsIds
Default: Describes all your DHCP options sets.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
dhcp-options-id - The
ID of a set of DHCP options.
key - The key
for one of the options (for example, domain-name).
value - The value for one of the options.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
ImageAttribute imageAttribute
com.amazonaws.internal.ListWithAutoConstructFlag<T> imageIds
Default: Describes all images available to you.
com.amazonaws.internal.ListWithAutoConstructFlag<T> owners
amazon (owner is Amazon), aws-marketplace
(owner is AWS Marketplace), self (owner is the sender of
the request), or all (all owners).com.amazonaws.internal.ListWithAutoConstructFlag<T> executableUsers
self (the sender of the request), or
all (public AMIs).com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
architecture - The
image architecture (i386 | x86_64).
block-device-mapping.delete-on-termination - A
Boolean value that indicates whether the Amazon EBS volume is deleted
on instance termination.
block-device-mapping.device-name - The device name for
the Amazon EBS volume (for example, /dev/sdh).
block-device-mapping.snapshot-id - The ID of the
snapshot used for the Amazon EBS volume.
block-device-mapping.volume-size - The volume size of
the Amazon EBS volume, in GiB.
block-device-mapping.volume-type - The volume type of
the Amazon EBS volume (gp2 | standard |
io1).
description - The
description of the image (provided during image creation).
hypervisor - The hypervisor type (ovm |
xen).
image-id - The ID of the
image.
image-type - The image type
(machine | kernel | ramdisk).
is-public - A Boolean that indicates
whether the image is public.
kernel-id -
The kernel ID.
manifest-location - The
location of the image manifest.
name - The
name of the AMI (provided during image creation).
owner-alias - The AWS account alias (for example,
amazon).
owner-id - The AWS
account ID of the image owner.
platform -
The platform. To only list Windows-based AMIs, use
windows.
product-code - The
product code.
product-code.type - The type
of the product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
root-device-name - The name of the root device volume
(for example, /dev/sda1).
root-device-type - The type of the root device volume
(ebs | instance-store).
state - The state of the image (available
| pending | failed).
state-reason-code - The reason code for the state
change.
state-reason-message - The message
for the state change.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For example, if
you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
virtualization-type - The
virtualization type (paravirtual | hvm).
java.lang.String instanceId
java.lang.String attribute
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport
InstanceAttribute instanceAttribute
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Default: Describes all your instances.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
architecture - The
instance architecture (i386 | x86_64).
availability-zone - The Availability Zone of the
instance.
block-device-mapping.attach-time
- The attach time for an Amazon EBS volume mapped to the instance, for
example, 2010-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean
that indicates whether the Amazon EBS volume is deleted on instance
termination.
block-device-mapping.device-name - The device name for
the Amazon EBS volume (for example, /dev/sdh).
block-device-mapping.status - The status for the
Amazon EBS volume (attaching | attached |
detaching | detached).
block-device-mapping.volume-id - The volume ID of the
Amazon EBS volume.
client-token - The
idempotency token you provided when you launched the instance.
dns-name - The public DNS name of the instance.
group-id - The ID of the security group for
the instance. EC2-Classic only.
group-name
- The name of the security group for the instance. EC2-Classic only.
hypervisor - The hypervisor type of the
instance (ovm | xen).
iam-instance-profile.arn - The instance profile
associated with the instance. Specified as an ARN.
image-id - The ID of the image used to launch the
instance.
instance-id - The ID of the
instance.
instance-lifecycle - Indicates
whether this is a Spot Instance (spot).
instance-state-code - The state of the instance, as a
16-bit unsigned integer. The high byte is an opaque internal value and
should be ignored. The low byte is set based on the state represented.
The valid values are: 0 (pending), 16 (running), 32 (shutting-down),
48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance
(pending | running |
shutting-down | terminated |
stopping | stopped).
instance-type - The type of instance (for example,
m1.small).
instance.group-id -
The ID of the security group for the instance.
instance.group-name - The name of the security group
for the instance.
ip-address - The public
IP address of the instance.
kernel-id - The
kernel ID.
key-name - The name of the key
pair used when the instance was launched.
launch-index - When launching multiple instances, this
is the index for the instance in the launch group (for example, 0, 1,
2, and so on).
launch-time - The time when
the instance was launched.
monitoring-state
- Indicates whether monitoring is enabled for the instance
(disabled | enabled).
owner-id - The AWS account ID of the instance owner.
placement-group-name - The name of the
placement group for the instance.
platform
- The platform. Use windows if you have Windows
instances; otherwise, leave blank.
private-dns-name - The private DNS name of the
instance.
private-ip-address - The private
IP address of the instance.
product-code -
The product code associated with the AMI used to launch the instance.
product-code.type - The type of product
code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the
instance (for example, shows "User Initiated [date]" when you stop or
terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that
launched the instance on your behalf (for example, AWS Management
Console, Auto Scaling, and so on).
reservation-id - The ID of the instance's reservation.
A reservation ID is created any time you launch an instance. A
reservation ID has a one-to-one relationship with an instance launch
request, but can be associated with more than one instance if you
launch multiple instances using the same launch request. For example,
if you launch one instance, you'll get one reservation ID. If you
launch ten instances using the same launch request, you'll also get
one reservation ID.
root-device-name - The
name of the root device for the instance (for example,
/dev/sda1).
root-device-type -
The type of root device that the instance uses (ebs |
instance-store).
source-dest-check - Indicates whether the instance
performs source/destination checking. A value of true
means that checking is enabled, and false means checking
is disabled. The value must be false for the instance to
perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance
request.
state-reason-code - The reason
code for the state change.
state-reason-message - A message that describes the
state change.
subnet-id - The ID of the
subnet for the instance.
tag:key=value - The key/value
combination of a tag assigned to the resource, where
tag:key is the tag's key.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
tenancy - The tenancy of an
instance (dedicated | default).
virtualization-type - The virtualization type of the
instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is
running in.
network-interface.description -
The description of the network interface.
network-interface.subnet-id - The ID of the subnet for
the network interface.
network-interface.vpc-id - The ID of the VPC for the
network interface.
network-interface.network-interface.id - The ID of the
network interface.
network-interface.owner-id - The ID of the owner of
the network interface.
network-interface.availability-zone - The Availability
Zone for the network interface.
network-interface.requester-id - The requester ID for
the network interface.
network-interface.requester-managed - Indicates
whether the network interface is being managed by AWS.
network-interface.status - The status of the network
interface (available) | in-use).
network-interface.mac-address - The MAC address of the
network interface.
network-interface-private-dns-name - The private DNS
name of the network interface.
network-interface.source-destination-check - Whether
the network interface performs source/destination checking. A value of
true means checking is enabled, and false
means checking is disabled. The value must be false for
the network interface to perform network address translation (NAT) in
your VPC.
network-interface.group-id - The
ID of a security group associated with the network interface.
network-interface.group-name - The name of a
security group associated with the network interface.
network-interface.attachment.attachment-id - The ID of
the interface attachment.
network-interface.attachment.instance-id - The ID of
the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The
owner ID of the instance to which the network interface is attached.
network-interface.addresses.private-ip-address - The
private IP address associated with the network interface.
network-interface.attachment.device-index - The device
index to which the network interface is attached.
network-interface.attachment.status - The status of
the attachment (attaching | attached |
detaching | detached).
network-interface.attachment.attach-time - The time
that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination -
Specifies whether the attachment is deleted when an instance is
terminated.
network-interface.addresses.primary - Specifies
whether the IP address of the network interface is the primary private
IP address.
network-interface.addresses.association.public-ip -
The ID of the association of an Elastic IP address with a network
interface.
network-interface.addresses.association.ip-owner-id -
The owner ID of the private IP address associated with the network
interface.
association.public-ip - The
address of the Elastic IP address bound to the network interface.
association.ip-owner-id - The owner of the
Elastic IP address associated with the network interface.
association.allocation-id - The allocation ID returned
when you allocated the Elastic IP address for your network interface.
association.association-id - The
association ID returned when the network interface was associated with
an IP address.
java.lang.String nextToken
java.lang.Integer maxResults
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone - The
Availability Zone of the instance.
event.code - The code identifying the type of event
(instance-reboot | system-reboot |
system-maintenance | instance-retirement |
instance-stop).
event.description - A description of the event.
event.not-after - The latest end time for the
scheduled event, for example: 2010-09-15T17:15:20.000Z.
event.not-before - The earliest start time
for the scheduled event, for example:
2010-09-15T17:15:20.000Z.
instance-state-code - A code representing the state of
the instance, as a 16-bit unsigned integer. The high byte is an opaque
internal value and should be ignored. The low byte is set based on the
state represented. The valid values are 0 (pending), 16 (running), 32
(shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the
instance (pending | running |
shutting-down | terminated |
stopping | stopped).
instance-status.reachability - Filters on instance
status where the name is reachability
(passed | failed | initializing
| insufficient-data).
instance-status.status - The status of the instance
(ok | impaired | initializing |
insufficient-data | not-applicable).
system-status.reachability - Filters on system
status where the name is reachability
(passed | failed | initializing
| insufficient-data).
system-status.status - The system status of the
instance (ok | impaired |
initializing | insufficient-data |
not-applicable).
java.lang.String nextToken
java.lang.Integer maxResults
Default: 1000
java.lang.Boolean includeAllInstances
true, includes the health status for all instances.
When false, includes the health status for running
instances only. Default: false
com.amazonaws.internal.ListWithAutoConstructFlag<T> internetGatewayIds
Default: Describes all your Internet gateways.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
attachment.state - The
current state of the attachment between the gateway and the VPC
(available). Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the
Internet gateway.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> keyNames
Default: Describes all your key pairs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
fingerprint - The
fingerprint of the key pair.
key-name - The
name of the key pair.
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkAclIds
Default: Describes all your network ACLs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
association.association-id - The ID of an association
ID for the ACL.
association.network-acl-id
- The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved
in the association.
default - Indicates
whether the ACL is the default network ACL for the VPC.
entry.cidr - The CIDR range specified in the entry.
entry.egress - Indicates whether the entry
applies to egress traffic.
entry.icmp.code
- The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the
entry, if any.
entry.port-range.from - The
start of the port range specified in the entry.
entry.port-range.to - The end of the port range
specified in the entry.
entry.protocol -
The protocol specified in the entry (tcp |
udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching
traffic (allow | deny).
entry.rule-number - The number of an entry (in other
words, rule) in the ACL's set of entries.
network-acl-id - The ID of the network ACL.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id - The ID of the VPC for the
network ACL.
java.lang.String networkInterfaceId
java.lang.String description
java.lang.Boolean sourceDestCheck
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
NetworkInterfaceAttachment attachment
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaceIds
Default: Describes all your network interfaces.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
addresses.private-ip-address - The private IP
addresses associated with the network interface.
addresses.primary - Whether the private IP address is
the primary IP address associated with the network interface.
addresses.association.public-ip - The association
ID returned when the network interface was associated with the Elastic
IP address.
addresses.association.owner-id
- The owner ID of the addresses associated with the network interface.
association.association-id - The
association ID returned when the network interface was associated with
an IP address.
association.allocation-id -
The allocation ID returned when you allocated the Elastic IP address
for your network interface.
association.ip-owner-id - The owner of the Elastic IP
address associated with the network interface.
association.public-ip - The address of the Elastic IP
address bound to the network interface.
association.public-dns-name - The public DNS name for
the network interface.
attachment.attachment-id - The ID of the interface
attachment.
attachment.instance-id - The ID
of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the
instance to which the network interface is attached.
attachment.device-index - The device index to which
the network interface is attached.
attachment.status - The status of the attachment
(attaching | attached |
detaching | detached).
attachment.attach.time - The time that the network
interface was attached to an instance.
attachment.delete-on-termination - Indicates whether
the attachment is deleted when an instance is terminated.
availability-zone - The Availability Zone of the
network interface.
description - The
description of the network interface.
group-id - The ID of a security group associated with
the network interface.
group-name - The
name of a security group associated with the network interface.
mac-address - The MAC address of the network
interface.
network-interface-id - The ID of
the network interface.
owner-id - The AWS
account ID of the network interface owner.
private-ip-address - The private IP address or
addresses of the network interface.
private-dns-name - The private DNS name of the network
interface.
requester-id - The ID of the
entity that launched the instance on your behalf (for example, AWS
Management Console, Auto Scaling, and so on).
requester-managed - Indicates whether the network
interface is being managed by an AWS service (for example, AWS
Management Console, Auto Scaling, and so on).
source-desk-check - Indicates whether the network
interface performs source/destination checking. A value of
true means checking is enabled, and false
means checking is disabled. The value must be false for
the network interface to perform Network Address Translation (NAT) in
your VPC.
status - The status of the
network interface. If the network interface is not attached to an
instance, the status is available; if a network interface
is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network
interface.
tag:key=value -
The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the
resource. This filter is independent of the tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and
the filter "tag-value=X", you get any resources assigned both the tag
key Purpose (regardless of what the tag's value is), and the tag value
X (regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id - The ID of the VPC for the
network interface.
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
Default: Describes all your placement groups, or only those otherwise specified.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
group-name - The name
of the placement group.
state - The state
of the placement group (pending | available
| deleting | deleted).
strategy - The strategy of the placement group
(cluster).
com.amazonaws.internal.ListWithAutoConstructFlag<T> regionNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
endpoint - The endpoint
of the region (for example, ec2.us-east-1.amazonaws.com).
region-name - The name of the region (for
example, us-east-1).
java.lang.String reservedInstancesId
java.lang.String reservedInstancesListingId
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
reserved-instances-id -
The ID of the Reserved Instances.
reserved-instances-listing-id - The ID of the Reserved
Instances listing.
status - The status of
the Reserved Instance listing (pending |
active | cancelled | closed).
status-message - The reason for the status.
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesModificationIds
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
client-token - The
idempotency token for the modification request.
create-date - The time when the modification request
was created.
effective-date - The time when
the modification becomes effective.
modification-result.reserved-instances-id - The ID for
the Reserved Instances created as part of the modification request.
This ID is only available when the status of the modification is
fulfilled.
modification-result.target-configuration.availability-zone
- The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count
- The number of new Reserved Instances.
modification-result.target-configuration.instance-type
- The instance type of the new Reserved Instances.
modification-result.target-configuration.platform -
The network platform of the new Reserved Instances
(EC2-Classic | EC2-VPC).
reserved-instances-id - The ID of the Reserved
Instances modified.
reserved-instances-modification-id - The ID of the
modification request.
status - The status
of the Reserved Instances modification request
(processing | fulfilled |
failed).
status-message - The
reason for the status.
update-date - The
time when the modification request was last updated.
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesOfferingIds
java.lang.String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, t2.micro, t2.small, t2.medium, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge
java.lang.String availabilityZone
java.lang.String productDescription
(Amazon VPC) in the description are for use with Amazon
VPC.
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone - The
Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (for
example, one year or three years), in seconds (31536000 |
94608000).
fixed-price - The
purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type on which the
Reserved Instance can be used.
marketplace
- Set to true to show only Reserved Instance Marketplace
offerings. When this filter is not used, which is the default
behavior, all offerings from AWS and Reserved Instance Marketplace are
listed.
product-description - The
description of the Reserved Instance (Linux/UNIX |
Linux/UNIX (Amazon VPC) | Windows |
Windows (Amazon VPC)).
reserved-instances-offering-id - The Reserved
Instances offering ID.
usage-price - The
usage price of the Reserved Instance, per hour (for example, 0.84).
java.lang.String instanceTenancy
dedicated tenancy runs on single-tenant hardware and
can only be launched within a VPC. Default: default
Constraints:
Allowed Values: default, dedicated
java.lang.String offeringType
Medium Utilization Reserved Instance offering type.
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
java.lang.String nextToken
java.lang.Integer maxResults
Default: 100
java.lang.Boolean includeMarketplace
java.lang.Long minDuration
Default: 2592000 (1 month)
java.lang.Long maxDuration
Default: 94608000 (3 years)
java.lang.Integer maxInstanceCount
Default: 20
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesIds
Default: Describes all your Reserved Instances, or only those otherwise specified.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone - The
Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (one
year or three years), in seconds (31536000 |
94608000).
end - The time when
the Reserved Instance expires (for example, 2014-08-07T11:54:42.000Z).
fixed-price - The purchase price of the
Reserved Instance (for example, 9800.0).
instance-type - The instance type on which the
Reserved Instance can be used.
product-description - The product description of the
Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon
VPC) | Windows | Windows (Amazon
VPC)).
reserved-instances-id - The
ID of the Reserved Instance.
start - The
time at which the Reserved Instance purchase request was placed (for
example, 2014-08-07T11:54:42.000Z).
state -
The state of the Reserved Instance (pending-payment |
active | payment-failed |
retired).
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
usage-price - The usage price of
the Reserved Instance, per hour (for example, 0.84).
java.lang.String offeringType
Medium Utilization Reserved Instance offering type.
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
com.amazonaws.internal.ListWithAutoConstructFlag<T> routeTableIds
Default: Describes all your route tables.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
association.route-table-association-id - The ID of an
association ID for the route table.
association.route-table-id - The ID of the route table
involved in the association.
association.subnet-id - The ID of the subnet involved
in the association.
association.main -
Indicates whether the route table is the main route table for the VPC.
route-table-id - The ID of the route table.
route.destination-cidr-block - The CIDR
range specified in a route in the table.
route.gateway-id - The ID of a gateway specified in a
route in the table.
route.instance-id - The
ID of an instance specified in a route in the table.
route.origin - Describes how the route was created.
CreateRouteTable indicates that the route was
automatically created when the route table was created;
CreateRoute indicates that the route was manually added
to the route table; EnableVgwRoutePropagation indicates
that the route was propagated by route propagation.
route.state - The state of a route in the route table
(active | blackhole). The blackhole state
indicates that the route's target isn't available (for example, the
specified gateway isn't attached to the VPC, the specified NAT
instance has been terminated, and so on).
route.vpc-peering-connection-id - The ID of a VPC
peering connection specified in a route in the table.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id - The ID of the VPC for the
route table.
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
Default: Describes all your security groups.
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupIds
Default: Describes all your security groups.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
description - The
description of the security group.
group-id
- The ID of the security group.
group-name
- The name of the security group.
ip-permission.cidr - A CIDR range that has been
granted permission.
ip-permission.from-port
- The start of port range for the TCP and UDP protocols, or an ICMP
type number.
ip-permission.group-id - The
ID of a security group that has been granted permission.
ip-permission.group-name - The name of a security
group that has been granted permission.
ip-permission.protocol - The IP protocol for the
permission (tcp | udp | icmp or
a protocol number).
ip-permission.to-port -
The end of port range for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id - The ID of an AWS
account that has been granted permission.
owner-id - The AWS account ID of the owner of the
security group.
tag-key - The key of a tag
assigned to the security group.
tag-value -
The value of a tag assigned to the security group.
vpc-id - The ID of the VPC specified when the security
group was created.
java.lang.String snapshotId
com.amazonaws.internal.ListWithAutoConstructFlag<T> createVolumePermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotIds
Default: Describes snapshots for which you have launch permissions.
com.amazonaws.internal.ListWithAutoConstructFlag<T> ownerIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> restorableByUserIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
description - A
description of the snapshot.
owner-alias -
The AWS account alias (for example, amazon) that owns the
snapshot.
owner-id - The ID of the AWS
account that owns the snapshot.
progress -
The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id - The snapshot ID.
start-time - The time stamp when the snapshot was
initiated.
status - The status of the
snapshot (pending | completed |
error).
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
volume-id - The ID of the volume
the snapshot is for.
volume-size - The size
of the volume, in GiB.
SpotDatafeedSubscription spotDatafeedSubscription
com.amazonaws.internal.ListWithAutoConstructFlag<T> spotInstanceRequestIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone-group
- The Availability Zone group.
create-time
- The time stamp when the Spot Instance request was created.
fault-code - The fault code related to the
request.
fault-message - The fault message
related to the request.
instance-id - The
ID of the instance that fulfilled the request.
launch-group - The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination
- Indicates whether the Amazon EBS volume is deleted on instance
termination.
launch.block-device-mapping.device-name - The device
name for the Amazon EBS volume (for example, /dev/sdh).
launch.block-device-mapping.snapshot-id -
The ID of the snapshot used for the Amazon EBS volume.
launch.block-device-mapping.volume-size - The size of
the Amazon EBS volume, in GiB.
launch.block-device-mapping.volume-type - The type of
the Amazon EBS volume (gp2 | standard |
io1).
launch.group-id - The
security group for the instance.
launch.image-id - The ID of the AMI.
launch.instance-type - The type of instance (for
example, m1.small).
launch.kernel-id - The kernel ID.
launch.key-name - The name of the key pair the
instance launched with.
launch.monitoring-enabled - Whether monitoring is
enabled for the Spot Instance.
launch.ramdisk-id - The RAM disk ID.
network-interface.network-interface-id - The ID of the
network interface.
network-interface.device-index - The index of the
device for the network interface attachment on the instance.
network-interface.subnet-id - The ID of the
subnet for the instance.
network-interface.description - A description of the
network interface.
network-interface.private-ip-address - The primary
private IP address of the network interface.
network-interface.delete-on-termination - Indicates
whether the network interface is deleted when the instance is
terminated.
network-interface.group-id -
The ID of the security group associated with the network interface.
network-interface.group-name - The name of
the security group associated with the network interface.
network-interface.addresses.primary - Indicates
whether the IP address is the primary private IP address.
product-description - The product description
associated with the instance (Linux/UNIX |
Windows).
spot-instance-request-id - The Spot Instance request
ID.
spot-price - The maximum hourly price
for any Spot Instance launched to fulfill the request.
state - The state of the Spot Instance request
(open | active | closed |
cancelled | failed). Spot bid status
information can help you track your Amazon EC2 Spot Instance requests.
For information, see Tracking
Spot Requests with Bid Status Codes in the Amazon Elastic Compute
Cloud User Guide for Linux.
status-code -
The short code describing the most recent evaluation of your Spot
Instance request.
status-message - The
message explaining the status of the Spot Instance request.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
type - The type of Spot Instance
request (one-time | persistent).
launched-availability-zone - The Availability Zone in
which the bid is launched.
valid-from - The
start date of the request.
valid-until -
The end date of the request.
java.util.Date startTime
java.util.Date endTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceTypes
com.amazonaws.internal.ListWithAutoConstructFlag<T> productDescriptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availability-zone - The
Availability Zone for which prices should be returned.
instance-type - The type of instance (for example,
m1.small).
product-description
- The product description for the Spot Price (Linux/UNIX
| SUSE Linux | Windows | Linux/UNIX
(Amazon VPC) | SUSE Linux (Amazon VPC) |
Windows (Amazon VPC)).
spot-price - The Spot Price. The value must match
exactly (or use wildcards; greater than or less than comparison is not
supported).
timestamp - The timestamp of
the Spot Price history (for example, 2010-08-16T05:06:11.000Z). You
can use wildcards (* and ?). Greater than or less than comparison is
not supported.
java.lang.String availabilityZone
java.lang.Integer maxResults
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
Default: Describes all your subnets.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
availabilityZone - The
Availability Zone for the subnet. You can also use
availability-zone as the filter name.
available-ip-address-count - The number of IP
addresses in the subnet that are available.
cidrBlock - The CIDR block of the subnet. The CIDR
block you specify must exactly match the subnet's CIDR block for
information to be returned for the subnet. You can also use
cidr or cidr-block as the filter names.
defaultForAz - Indicates whether this is
the default subnet for the Availability Zone. You can also use
default-for-az as the filter name.
state - The state of the subnet (pending
| available).
subnet-id - The
ID of the subnet.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id - The ID of the VPC for the
subnet.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
key - The tag key.
resource-id - The resource ID.
resource-type - The resource type
(customer-gateway | dhcp-options |
image | instance |
internet-gateway | network-acl |
network-interface | reserved-instances |
route-table | security-group |
snapshot | spot-instances-request |
subnet | volume | vpc |
vpn-connection | vpn-gateway).
value - The tag value.
java.lang.Integer maxResults
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
attachment.attach-time
- The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume
is deleted on instance termination.
attachment.device - The device name that is exposed to
the instance (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the
volume is attached to.
attachment.status -
The attachment state (attaching | attached |
detaching | detached).
availability-zone - The Availability Zone in which the
volume was created.
create-time - The time
stamp when the volume was created.
encrypted - The encryption status of the volume.
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was
created.
status - The status of the volume
(creating | available | in-use
| deleting | deleted | error).
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type. This
can be gp2 for General Purpose (SSD) volumes,
io1 for Provisioned IOPS (SSD) volumes, or
standard for Magnetic volumes.
java.lang.String nextToken
NextToken value returned from a previous paginated
DescribeVolumes request where MaxResults was
used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
NextToken value. This value is null when
there are no more results to return.java.lang.Integer maxResults
DescribeVolumes in paginated output. When this parameter
is used, DescribeVolumes only returns
MaxResults results in a single page along with a
NextToken response element. The remaining results of the
initial request can be seen by sending another
DescribeVolumes request with the returned
NextToken value. This value can be between 5 and 1000; if
MaxResults is given a value larger than 1000, only 1000
results are returned. If this parameter is not used, then
DescribeVolumes returns all results.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumes
java.lang.String nextToken
NextToken value to include in a future
DescribeVolumes request. When the results of a
DescribeVolumes request exceed MaxResults,
this value can be used to retrieve the next page of results. This
value is null when there are no more results to return.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeIds
Default: Describes all your volumes.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
action.code - The
action code for the event (for example,
enable-volume-io).
action.description - A description of the action.
action.event-id - The event ID associated
with the action.
availability-zone - The
Availability Zone of the instance.
event.description - A description of the event.
event.event-id - The event ID.
event.event-type - The event type (for
io-enabled: passed | failed;
for io-performance: io-performance:degraded
| io-performance:severely-degraded |
io-performance:stalled).
event.not-after - The latest end time for the event.
event.not-before - The earliest start time
for the event.
volume-status.details-name -
The cause for volume-status.status
(io-enabled | io-performance).
volume-status.details-status - The status of
volume-status.details-name (for io-enabled:
passed | failed; for
io-performance: normal |
degraded | severely-degraded |
stalled).
volume-status.status
- The status of the volume (ok | impaired |
warning | insufficient-data).
java.lang.String nextToken
java.lang.Integer maxResults
java.lang.String vpcId
java.lang.Boolean enableDnsSupport
true, the Amazon DNS server resolves DNS
hostnames for your instances to their corresponding IP addresses;
otherwise, it does not.java.lang.Boolean enableDnsHostnames
true, instances in the VPC get DNS
hostnames; otherwise, they do not.com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
is-classic-link-enabled
- Whether the VPC is enabled for ClassicLink (true |
false).
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcPeeringConnectionIds
Default: Describes all your VPC peering connections.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
accepter-vpc-info.cidr-block - The CIDR block of the
peer VPC.
accepter-vpc-info.owner-id - The
AWS account ID of the owner of the peer VPC.
accepter-vpc-info.vpc-id - The ID of the peer VPC.
expiration-time - The expiration date and
time for the VPC peering connection.
requester-vpc-info.cidr-block - The CIDR block of the
requester's VPC.
requester-vpc-info.owner-id - The AWS account ID of
the owner of the requester VPC.
requester-vpc-info.vpc-id - The ID of the requester
VPC.
status-code - The status of the VPC
peering connection (pending-acceptance |
failed | expired | provisioning
| active | deleted | rejected).
status-message - A message that provides
more information about the status of the VPC peering connection, if
applicable.
tag:key=value -
The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the
resource. This filter is independent of the tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and
the filter "tag-value=X", you get any resources assigned both the tag
key Purpose (regardless of what the tag's value is), and the tag value
X (regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-peering-connection-id - The ID
of the VPC peering connection.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcIds
Default: Describes all your VPCs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
cidr - The CIDR block
of the VPC. The CIDR block you specify must exactly match the VPC's
CIDR block for information to be returned for the VPC. Must contain
the slash followed by one or two digits (for example,
/28).
dhcp-options-id - The ID
of a set of DHCP options.
isDefault -
Indicates whether the VPC is the default VPC.
state - The state of the VPC (pending |
available).
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
vpc-id - The ID of the VPC.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnConnectionIds
Default: Describes your VPN connections.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
customer-gateway-configuration - The configuration
information for the customer gateway.
customer-gateway-id - The ID of a customer gateway
associated with the VPN connection.
state -
The state of the VPN connection (pending |
available | deleting |
deleted).
option.static-routes-only - Indicates whether the
connection has static routes only. Used for devices that do not
support Border Gateway Protocol (BGP).
route.destination-cidr-block - The destination CIDR
block. This corresponds to the subnet used in a customer data center.
bgp-asn - The BGP Autonomous System Number
(ASN) associated with a BGP device.
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
type - The type of VPN connection.
Currently the only supported type is ipsec.1.
vpn-connection-id - The ID of the VPN connection.
vpn-gateway-id - The ID of a virtual
private gateway associated with the VPN connection.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpnGatewayIds
Default: Describes all your virtual private gateways.
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
attachment.state - The
current state of the attachment between the gateway and the VPC
(attaching | attached |
detaching | detached).
attachment.vpc-id - The ID of an attached VPC.
availability-zone - The Availability Zone for the
virtual private gateway.
state - The state
of the virtual private gateway (pending |
available | deleting |
deleted).
tag:key=value - The key/value
combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For
example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag:key=value filter.
tag-value - The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
type - The type of virtual private
gateway. Currently the only supported type is ipsec.1.
vpn-gateway-id - The ID of the virtual
private gateway.
java.lang.String volumeId
java.lang.String instanceId
java.lang.String device
java.lang.Boolean force
VolumeAttachment attachment
java.lang.String dhcpOptionsId
com.amazonaws.internal.ListWithAutoConstructFlag<T> dhcpConfigurations
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
DiskImageDetail image
java.lang.String description
VolumeDetail volume
java.lang.String format
Constraints:
Allowed Values: VMDK, RAW, VHD
java.lang.Long size
java.lang.String importManifestUrl
java.lang.String checksum
java.lang.String format
Constraints:
Allowed Values: VMDK, RAW, VHD
java.lang.Long bytes
java.lang.String importManifestUrl
java.lang.String snapshotId
java.lang.Integer volumeSize
Constraints: If the volume type is
io1, the minimum size of the volume is 10 GiB; otherwise,
the minimum size is 1 GiB. The maximum volume size is 1024 GiB. If you
specify a snapshot, the volume size must be equal to or larger than
the snapshot size.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
java.lang.Boolean deleteOnTermination
java.lang.String volumeType
gp2 for General Purpose (SSD) volumes,
io1 for Provisioned IOPS (SSD) volumes, and
standard for Magnetic volumes. Default:
standard
Constraints:
Allowed Values: standard, io1, gp2
java.lang.Integer iops
Constraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes.
Condition: This parameter is required for requests to create
io1 volumes; it is not used in requests to create
standard or gp2 volumes.
java.lang.Boolean encrypted
java.lang.String volumeId
java.lang.String status
Constraints:
Allowed Values: attaching, attached, detaching, detached
java.util.Date attachTime
java.lang.Boolean deleteOnTermination
java.lang.String exportTaskId
java.lang.String description
java.lang.String state
Constraints:
Allowed Values: active, cancelling, cancelled, completed
java.lang.String statusMessage
InstanceExportDetails instanceExportDetails
ExportToS3Task exportToS3Task
java.lang.String diskImageFormat
Constraints:
Allowed Values: VMDK, RAW, VHD
java.lang.String containerFormat
Constraints:
Allowed Values: ova
java.lang.String s3Bucket
vm-import-export@amazon.com.java.lang.String s3Key
java.lang.String diskImageFormat
Constraints:
Allowed Values: VMDK, RAW, VHD
java.lang.String containerFormat
Constraints:
Allowed Values: ova
java.lang.String s3Bucket
java.lang.String s3Prefix
java.lang.String imageId
java.lang.String imageLocation
java.lang.String state
available,
the image is successfully registered and can be used to launch an
instance.
Constraints:
Allowed Values: available, deregistered
java.lang.String ownerId
java.lang.Boolean publicValue
true if this image has public launch permissions or
false if it has only implicit and explicit launch
permissions.com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
java.lang.String architecture
Constraints:
Allowed Values: i386, x86_64
java.lang.String imageType
Constraints:
Allowed Values: machine, kernel, ramdisk
java.lang.String kernelId
java.lang.String ramdiskId
java.lang.String platform
Windows for Windows AMIs; otherwise blank.
Constraints:
Allowed Values: Windows
java.lang.String sriovNetSupport
StateReason stateReason
java.lang.String imageOwnerAlias
amazon,
self) or the AWS account ID of the AMI owner.java.lang.String name
java.lang.String description
java.lang.String rootDeviceType
Constraints:
Allowed Values: ebs, instance-store
java.lang.String rootDeviceName
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
java.lang.String virtualizationType
Constraints:
Allowed Values: hvm, paravirtual
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String hypervisor
Constraints:
Allowed Values: ovm, xen
java.lang.String imageId
com.amazonaws.internal.ListWithAutoConstructFlag<T> launchPermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
java.lang.String kernelId
java.lang.String ramdiskId
java.lang.String description
java.lang.String sriovNetSupport
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
java.lang.String architecture
Constraints:
Allowed Values: i386, x86_64
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupIds
java.lang.String additionalInfo
UserData userData
java.lang.String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, t2.micro, t2.small, t2.medium, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge
Placement placement
java.lang.Boolean monitoring
java.lang.String subnetId
java.lang.String instanceInitiatedShutdownBehavior
Constraints:
Allowed Values: stop, terminate
java.lang.String privateIpAddress
java.lang.String description
ImportInstanceLaunchSpecification launchSpecification
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskImages
java.lang.String platform
Constraints:
Allowed Values: Windows
ConversionTask conversionTask
java.lang.Long bytesConverted
java.lang.String availabilityZone
DiskImageDescription image
DiskImageVolumeDescription volume
java.lang.String status
java.lang.String statusMessage
java.lang.String description
java.lang.String availabilityZone
DiskImageDetail image
java.lang.String description
VolumeDetail volume
ConversionTask conversionTask
java.lang.Long bytesConverted
java.lang.String availabilityZone
java.lang.String description
DiskImageDescription image
DiskImageVolumeDescription volume
java.lang.String instanceId
java.lang.String imageId
InstanceState state
java.lang.String privateDnsName
running state.java.lang.String publicDnsName
running state.java.lang.String stateTransitionReason
java.lang.String keyName
java.lang.Integer amiLaunchIndex
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
java.lang.String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, t2.micro, t2.small, t2.medium, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge
java.util.Date launchTime
Placement placement
java.lang.String kernelId
java.lang.String ramdiskId
java.lang.String platform
Windows for Windows instances; otherwise
blank.
Constraints:
Allowed Values: Windows
Monitoring monitoring
java.lang.String subnetId
java.lang.String vpcId
java.lang.String privateIpAddress
java.lang.String publicIpAddress
StateReason stateReason
java.lang.String architecture
Constraints:
Allowed Values: i386, x86_64
java.lang.String rootDeviceType
Constraints:
Allowed Values: ebs, instance-store
java.lang.String rootDeviceName
/dev/sda1).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
java.lang.String virtualizationType
Constraints:
Allowed Values: hvm, paravirtual
java.lang.String instanceLifecycle
Constraints:
Allowed Values: spot
java.lang.String spotInstanceRequestId
java.lang.String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
java.lang.Boolean sourceDestCheck
true means checking is enabled,
and false means checking is disabled. The value must be
false for the instance to perform NAT. For more
information, see NAT
Instances in the Amazon Virtual Private Cloud User Guide.java.lang.String hypervisor
Constraints:
Allowed Values: ovm, xen
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfile iamInstanceProfile
java.lang.Boolean ebsOptimized
java.lang.String sriovNetSupport
java.lang.String instanceId
java.lang.String instanceType
java.lang.String kernelId
java.lang.String ramdiskId
java.lang.String userData
java.lang.Boolean disableApiTermination
true, you can't terminate the instance
through the Amazon EC2 console, CLI, or API; otherwise, you can.java.lang.String instanceInitiatedShutdownBehavior
java.lang.String rootDeviceName
/dev/sda1).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
java.lang.Boolean ebsOptimized
java.lang.String sriovNetSupport
java.lang.Boolean sourceDestCheck
true means checking is enabled, and false
means checking is disabled. This value must be false for
a NAT instance to perform NAT.com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
java.lang.String deviceName
EbsInstanceBlockDevice ebs
java.lang.String deviceName
EbsInstanceBlockDeviceSpecification ebs
java.lang.String virtualName
java.lang.String noDevice
java.lang.String instanceId
Monitoring monitoring
java.lang.String networkInterfaceId
java.lang.String subnetId
java.lang.String vpcId
java.lang.String description
java.lang.String ownerId
java.lang.String status
Constraints:
Allowed Values: available, attaching, in-use, detaching
java.lang.String macAddress
java.lang.String privateIpAddress
java.lang.String privateDnsName
java.lang.Boolean sourceDestCheck
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
InstanceNetworkInterfaceAttachment attachment
InstanceNetworkInterfaceAssociation association
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
java.lang.String attachmentId
java.lang.Integer deviceIndex
java.lang.String status
Constraints:
Allowed Values: attaching, attached, detaching, detached
java.util.Date attachTime
java.lang.Boolean deleteOnTermination
java.lang.String networkInterfaceId
java.lang.Integer deviceIndex
java.lang.String subnetId
java.lang.String description
java.lang.String privateIpAddress
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
java.lang.Boolean deleteOnTermination
true, the interface is deleted when the
instance is terminated. You can specify true only if
creating a new network interface when launching an instance.com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
java.lang.Integer secondaryPrivateIpAddressCount
java.lang.Boolean associatePublicIpAddress
true.java.lang.String privateIpAddress
java.lang.String privateDnsName
java.lang.Boolean primary
InstanceNetworkInterfaceAssociation association
java.lang.Integer code
0 :
pending
16 :
running
32 :
shutting-down
48 :
terminated
64 :
stopping
80 :
stopped
java.lang.String name
Constraints:
Allowed Values: pending, running, shutting-down, terminated, stopping, stopped
java.lang.String instanceId
InstanceState currentState
InstanceState previousState
java.lang.String instanceId
java.lang.String availabilityZone
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
InstanceState instanceState
running state.InstanceStatusSummary systemStatus
InstanceStatusSummary instanceStatus
java.lang.String name
Constraints:
Allowed Values: reachability
java.lang.String status
Constraints:
Allowed Values: passed, failed, insufficient-data
java.util.Date impairedSince
java.lang.String code
Constraints:
Allowed Values: instance-reboot, system-reboot, system-maintenance, instance-retirement, instance-stop
java.lang.String description
java.util.Date notBefore
java.util.Date notAfter
java.lang.String internetGatewayId
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachments
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String ipProtocol
When you call DescribeSecurityGroups, the
protocol value returned is the number. Exception: For TCP, UDP, and
ICMP, the value returned is the name (for example, tcp,
udp, or icmp). For a list of protocol
numbers, see Protocol
Numbers.
java.lang.Integer fromPort
-1 indicates all ICMP types.java.lang.Integer toPort
-1 indicates all ICMP codes for the specified
ICMP type.com.amazonaws.internal.ListWithAutoConstructFlag<T> userIdGroupPairs
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipRanges
java.lang.String keyName
java.lang.String keyFingerprint
java.lang.String imageId
java.lang.String keyName
com.amazonaws.internal.ListWithAutoConstructFlag<T> allSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
java.lang.String userData
java.lang.String addressingType
java.lang.String instanceType
Default: m1.small
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, t2.micro, t2.small, t2.medium, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge
SpotPlacement placement
java.lang.String kernelId
java.lang.String ramdiskId
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
java.lang.Boolean monitoringEnabled
Default: Disabled
java.lang.String subnetId
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfileSpecification iamInstanceProfile
java.lang.Boolean ebsOptimized
Default:
false
java.lang.String imageId
java.lang.String attribute
java.lang.String operationType
com.amazonaws.internal.ListWithAutoConstructFlag<T> userIds
launchPermission attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> userGroups
launchPermission attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> productCodes
productCodes attribute.java.lang.String value
description attribute.LaunchPermissionModifications launchPermission
java.lang.String description
java.lang.String instanceId
java.lang.String attribute
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport
java.lang.String value
kernel,
ramdisk, userData,
disableApiTermination, or
intanceInitiateShutdownBehavior attribute.com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
DeleteOnTermination attribute for volumes
that are currently attached. The volume must be owned by the caller.
If no value is specified for DeleteOnTermination, the
default is true and the volume is deleted when the
instance is terminated. To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.
java.lang.Boolean sourceDestCheck
true means that checking is enabled, and
false means checking is disabled. This value must be
false for a NAT instance to perform NAT.java.lang.Boolean disableApiTermination
true, you can't terminate the instance
using the Amazon EC2 console, CLI, or API; otherwise, you can.java.lang.String instanceType
InvalidInstanceAttributeValue.java.lang.String kernel
java.lang.String ramdisk
java.lang.String userData
java.lang.String instanceInitiatedShutdownBehavior
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
For example, if you want the instance
to be in sg-1a1a1a1a and sg-9b9b9b9b, specify
GroupId.1=sg-1a1a1a1a and
GroupId.2=sg-9b9b9b9b.
java.lang.Boolean ebsOptimized
java.lang.String sriovNetSupport
simple to enable enhanced networking for the
instance. There is no way to disable enhanced networking at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
java.lang.String networkInterfaceId
java.lang.String description
java.lang.Boolean sourceDestCheck
true means checking is enabled, and false
means checking is disabled. This value must be false for
a NAT instance to perform NAT. For more information, see NAT
Instances in the Amazon Virtual Private Cloud User Guide.com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
NetworkInterfaceAttachmentChanges attachment
java.lang.String clientToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> targetConfigurations
java.lang.String snapshotId
java.lang.String attribute
Constraints:
Allowed Values: productCodes, createVolumePermission
java.lang.String operationType
com.amazonaws.internal.ListWithAutoConstructFlag<T> userIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
CreateVolumePermissionModifications createVolumePermission
java.lang.String vpcId
java.lang.Boolean enableDnsSupport
java.lang.Boolean enableDnsHostnames
You can only enable DNS hostnames if you also enable DNS support.
java.lang.String networkAclId
java.lang.String vpcId
java.lang.Boolean isDefault
com.amazonaws.internal.ListWithAutoConstructFlag<T> entries
com.amazonaws.internal.ListWithAutoConstructFlag<T> associations
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.Integer ruleNumber
java.lang.String protocol
-1 means all protocols.java.lang.String ruleAction
Constraints:
Allowed Values: allow, deny
java.lang.Boolean egress
java.lang.String cidrBlock
IcmpTypeCode icmpTypeCode
PortRange portRange
java.lang.String networkInterfaceId
java.lang.String subnetId
java.lang.String vpcId
java.lang.String availabilityZone
java.lang.String description
java.lang.String ownerId
java.lang.String requesterId
java.lang.Boolean requesterManaged
java.lang.String status
Constraints:
Allowed Values: available, attaching, in-use, detaching
java.lang.String macAddress
java.lang.String privateIpAddress
java.lang.String privateDnsName
java.lang.Boolean sourceDestCheck
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
NetworkInterfaceAttachment attachment
NetworkInterfaceAssociation association
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagSet
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
java.lang.String publicIp
java.lang.String publicDnsName
java.lang.String ipOwnerId
java.lang.String allocationId
java.lang.String associationId
java.lang.String attachmentId
java.lang.String instanceId
java.lang.String instanceOwnerId
java.lang.Integer deviceIndex
java.lang.String status
Constraints:
Allowed Values: attaching, attached, detaching, detached
java.util.Date attachTime
java.lang.Boolean deleteOnTermination
java.lang.String privateIpAddress
java.lang.String privateDnsName
java.lang.Boolean primary
NetworkInterfaceAssociation association
java.lang.String availabilityZone
java.lang.String groupName
java.lang.String tenancy
dedicated runs on
single-tenant hardware.
Constraints:
Allowed Values: default, dedicated
java.lang.String groupName
java.lang.String strategy
Constraints:
Allowed Values: cluster
java.lang.String state
Constraints:
Allowed Values: pending, available, deleting, deleted
java.lang.Long term
java.lang.Double price
java.lang.String currencyCode
USD.
Constraints:
Allowed Values: USD
java.lang.Boolean active
A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.
java.lang.Long term
java.lang.Double price
java.lang.String currencyCode
USD.
Constraints:
Allowed Values: USD
java.lang.String reservedInstancesOfferingId
java.lang.Integer instanceCount
ReservedInstanceLimitPrice limitPrice
java.lang.String imageLocation
java.lang.String name
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
java.lang.String description
java.lang.String architecture
Default: For Amazon EBS-backed AMIs,
i386. For instance store-backed AMIs, the architecture
specified in the manifest file.
Constraints:
Allowed Values: i386, x86_64
java.lang.String kernelId
java.lang.String ramdiskId
java.lang.String rootDeviceName
/dev/sda1, or
xvda).com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
java.lang.String virtualizationType
Default: paravirtual
java.lang.String sriovNetSupport
simple to enable enhanced networking for the AMI
and any instances that you launch from the AMI. There is no way to disable enhanced networking at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
java.lang.String networkAclId
java.lang.Integer ruleNumber
java.lang.String protocol
all or -1
to mean all protocols.java.lang.String ruleAction
Constraints:
Allowed Values: allow, deny
java.lang.Boolean egress
Default: If no value is specified, we replace the ingress rule.
java.lang.String cidrBlock
IcmpTypeCode icmpTypeCode
PortRange portRange
java.lang.String routeTableId
java.lang.String destinationCidrBlock
java.lang.String gatewayId
java.lang.String instanceId
java.lang.String networkInterfaceId
java.lang.String vpcPeeringConnectionId
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
java.lang.String status
Constraints:
Allowed Values: ok, impaired
java.util.Date startTime
java.util.Date endTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> reasonCodes
instance-stuck-in-state: My
instance is stuck in a state.
unresponsive:
My instance is unresponsive.
not-accepting-credentials: My instance is not
accepting my credentials.
password-not-available: A password is not
available for my instance.
performance-network: My instance is experiencing
performance problems which I believe are network related.
performance-instance-store: My instance is
experiencing performance problems which I believe are related to the
instance stores.
performance-ebs-volume: My
instance is experiencing performance problems which I believe are
related to an EBS volume.
performance-other:
My instance is experiencing performance problems.
other: [explain using the description
parameter]
java.lang.String description
java.lang.String spotPrice
java.lang.Integer instanceCount
Default: 1
java.lang.String type
Default: one-time
Constraints:
Allowed Values: one-time, persistent
java.util.Date validFrom
Default: The request is effective indefinitely.
java.util.Date validUntil
Default: The request is effective indefinitely.
java.lang.String launchGroup
Default: Instances are launched and terminated individually
java.lang.String availabilityZoneGroup
When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
Default: Instances are launched in any available Availability Zone.
LaunchSpecification launchSpecification
java.lang.String reservationId
java.lang.String ownerId
java.lang.String requesterId
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
java.lang.Double amount
java.lang.String currencyCode
limitPrice amount is specified.
At this time, the only supported currency is USD.
Constraints:
Allowed Values: USD
java.lang.String reservedInstancesId
java.lang.String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, t2.micro, t2.small, t2.medium, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge
java.lang.String availabilityZone
java.util.Date start
java.util.Date end
java.lang.Long duration
java.lang.Float usagePrice
java.lang.Float fixedPrice
java.lang.Integer instanceCount
java.lang.String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
java.lang.String state
Constraints:
Allowed Values: payment-pending, active, payment-failed, retired
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String instanceTenancy
Constraints:
Allowed Values: default, dedicated
java.lang.String currencyCode
USD.
Constraints:
Allowed Values: USD
java.lang.String offeringType
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
java.lang.String availabilityZone
java.lang.String platform
java.lang.Integer instanceCount
java.lang.String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, t2.micro, t2.small, t2.medium, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge
java.lang.String reservedInstancesListingId
java.lang.String reservedInstancesId
java.util.Date createDate
java.util.Date updateDate
java.lang.String status
Constraints:
Allowed Values: active, pending, cancelled, closed
java.lang.String statusMessage
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceCounts
com.amazonaws.internal.ListWithAutoConstructFlag<T> priceSchedules
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String clientToken
java.lang.String reservedInstancesModificationId
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedInstancesIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> modificationResults
java.util.Date createDate
java.util.Date updateDate
java.util.Date effectiveDate
java.lang.String status
java.lang.String statusMessage
java.lang.String clientToken
java.lang.String reservedInstancesId
ReservedInstancesConfiguration targetConfiguration
java.lang.String reservedInstancesOfferingId
java.lang.String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, t2.micro, t2.small, t2.medium, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge
java.lang.String availabilityZone
java.lang.Long duration
java.lang.Float usagePrice
java.lang.Float fixedPrice
java.lang.String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
java.lang.String instanceTenancy
Constraints:
Allowed Values: default, dedicated
java.lang.String currencyCode
USD.
Constraints:
Allowed Values: USD
java.lang.String offeringType
Constraints:
Allowed Values: Heavy Utilization, Medium Utilization, Light Utilization
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
java.lang.Boolean marketplace
true.com.amazonaws.internal.ListWithAutoConstructFlag<T> pricingDetails
java.lang.String instanceId
java.lang.String attribute
Constraints:
Allowed Values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport
java.lang.String groupId
java.lang.String sourceSecurityGroupName
java.lang.String sourceSecurityGroupOwnerId
java.lang.String ipProtocol
java.lang.Integer fromPort
-1 to specify all
ICMP types.java.lang.Integer toPort
-1 to specify all
ICMP codes for the ICMP type.java.lang.String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
java.lang.String groupName
java.lang.String groupId
java.lang.String sourceSecurityGroupName
java.lang.String sourceSecurityGroupOwnerId
java.lang.String ipProtocol
java.lang.Integer fromPort
-1 to specify all
ICMP types.java.lang.Integer toPort
-1 to specify all
ICMP codes for the ICMP type.java.lang.String cidrIp
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
java.lang.String destinationCidrBlock
java.lang.String gatewayId
java.lang.String instanceId
java.lang.String instanceOwnerId
java.lang.String networkInterfaceId
java.lang.String vpcPeeringConnectionId
java.lang.String state
blackhole state indicates
that the route's target isn't available (for example, the specified
gateway isn't attached to the VPC, or the specified NAT instance has
been terminated).
Constraints:
Allowed Values: active, blackhole
java.lang.String origin
CreateRouteTable indicates that route was
automatically created when the route table was created.CreateRoute indicates that the route was manually
added to the route table.EnableVgwRoutePropagation indicates that the route
was propagated by route propagation.
Constraints:
Allowed Values: CreateRouteTable, CreateRoute, EnableVgwRoutePropagation
java.lang.String routeTableId
java.lang.String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> routes
com.amazonaws.internal.ListWithAutoConstructFlag<T> associations
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> propagatingVgws
java.lang.String routeTableAssociationId
java.lang.String routeTableId
java.lang.String subnetId
java.lang.Boolean main
java.lang.String imageId
java.lang.Integer minCount
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
java.lang.Integer maxCount
MinCount. Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
java.lang.String keyName
If you launch an instance without specifying a key pair, you can't connect to the instance.
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
Default: Amazon EC2 uses the default security group.
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
Default: Amazon EC2 uses the default security group.
java.lang.String userData
java.lang.String instanceType
Default: m1.small
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, t2.micro, t2.small, t2.medium, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge
Placement placement
java.lang.String kernelId
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.
java.lang.String ramdiskId
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> blockDeviceMappings
java.lang.Boolean monitoring
java.lang.String subnetId
java.lang.Boolean disableApiTermination
true, you can't terminate
the instance using the Amazon EC2 console, CLI, or API; otherwise, you
can. If you set this parameter to true and then later
want to be able to terminate the instance, you must first change the
value of the disableApiTermination attribute to
false using ModifyInstanceAttribute.
Alternatively, if you set
InstanceInitiatedShutdownBehavior to
terminate, you can terminate the instance by running the
shutdown command from the instance. Default: false
java.lang.String instanceInitiatedShutdownBehavior
Default: stop
Constraints:
Allowed Values: stop, terminate
java.lang.String privateIpAddress
Only one private IP address can be
designated as primary. Therefore, you can't specify this parameter if
PrivateIpAddresses.n.Primary is set to true
and PrivateIpAddresses.n.PrivateIpAddress is set to an IP
address.
Default: We select an IP address from the IP address range of the subnet.
java.lang.String clientToken
Constraints: Maximum 64 ASCII characters
java.lang.String additionalInfo
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkInterfaces
IamInstanceProfileSpecification iamInstanceProfile
java.lang.Boolean ebsOptimized
Default: false
Reservation reservation
java.lang.String bucket
java.lang.String prefix
java.lang.String aWSAccessKeyId
java.lang.String uploadPolicy
java.lang.String uploadPolicySignature
java.lang.String ownerId
java.lang.String groupName
java.lang.String groupId
java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> ipPermissionsEgress
java.lang.String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String snapshotId
java.lang.String volumeId
java.lang.String state
Constraints:
Allowed Values: pending, completed, error
java.util.Date startTime
java.lang.String progress
java.lang.String ownerId
java.lang.String description
java.lang.Integer volumeSize
java.lang.String ownerAlias
amazon,
self) or AWS account ID that owns the snapshot.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.Boolean encrypted
java.lang.String kmsKeyId
java.lang.String ownerId
java.lang.String bucket
java.lang.String prefix
java.lang.String state
Constraints:
Allowed Values: Active, Inactive
SpotInstanceStateFault fault
java.lang.String spotInstanceRequestId
java.lang.String spotPrice
java.lang.String type
Constraints:
Allowed Values: one-time, persistent
java.lang.String state
Constraints:
Allowed Values: open, active, closed, cancelled, failed
SpotInstanceStateFault fault
SpotInstanceStatus status
java.util.Date validFrom
java.util.Date validUntil
java.lang.String launchGroup
java.lang.String availabilityZoneGroup
LaunchSpecification launchSpecification
java.lang.String instanceId
java.util.Date createTime
java.lang.String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String launchedAvailabilityZone
java.lang.String instanceType
Constraints:
Allowed Values: t1.micro, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, t2.micro, t2.small, t2.medium, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, cg1.4xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge
java.lang.String productDescription
Constraints:
Allowed Values: Linux/UNIX, Linux/UNIX (Amazon VPC), Windows, Windows (Amazon VPC)
java.lang.String spotPrice
java.util.Date timestamp
java.lang.String availabilityZone
java.lang.String code
java.lang.String message
Server.SpotInstanceTermination: A Spot Instance
was terminated due to an increase in the market price.
Server.InternalError: An internal error occurred
during instance launch, resulting in termination.
Server.InsufficientInstanceCapacity: There was
insufficient instance capacity to satisfy the launch request.
Client.InternalError: A client error caused the
instance to terminate on launch.
Client.InstanceInitiatedShutdown: The instance was
shut down using the shutdown -h command from the
instance.
Client.UserInitiatedShutdown: The
instance was shut down using the Amazon EC2 API.
Client.VolumeLimitExceeded: The volume limit was
exceeded.
Client.InvalidSnapshot.NotFound:
The specified snapshot was not found.
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
java.lang.Boolean force
Default:
false
S3Storage s3
java.lang.String subnetId
java.lang.String state
Constraints:
Allowed Values: pending, available
java.lang.String vpcId
java.lang.String cidrBlock
java.lang.Integer availableIpAddressCount
java.lang.String availabilityZone
java.lang.Boolean defaultForAz
java.lang.Boolean mapPublicIpOnLaunch
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String key
Constraints: Tag keys are case-sensitive and
accept a maximum of 127 Unicode characters. May not begin with
aws:
java.lang.String value
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
java.lang.String resourceId
ami-1a2b3c4d.java.lang.String resourceType
Constraints:
Allowed Values: customer-gateway, dhcp-options, image, instance, internet-gateway, network-acl, network-interface, reserved-instances, route-table, snapshot, spot-instances-request, subnet, security-group, volume, vpc, vpn-connection, vpn-gateway
java.lang.String key
java.lang.String value
java.lang.String networkInterfaceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> privateIpAddresses
java.lang.String outsideIpAddress
java.lang.String status
Constraints:
Allowed Values: UP, DOWN
java.util.Date lastStatusChange
java.lang.String statusMessage
java.lang.Integer acceptedRouteCount
java.lang.String volumeId
java.lang.Integer size
java.lang.String snapshotId
java.lang.String availabilityZone
java.lang.String state
Constraints:
Allowed Values: creating, available, in-use, deleting, deleted, error
java.util.Date createTime
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachments
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String volumeType
gp2 for General Purpose
(SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or
standard for Magnetic volumes.
Constraints:
Allowed Values: standard, io1, gp2
java.lang.Integer iops
Constraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes.
Condition: This parameter is required for requests to create
io1 volumes; it is not used in requests to create
standard or gp2 volumes.
java.lang.Boolean encrypted
java.lang.String kmsKeyId
java.lang.String volumeId
java.lang.String instanceId
java.lang.String device
java.lang.String state
Constraints:
Allowed Values: attaching, attached, detaching, detached
java.util.Date attachTime
java.lang.Boolean deleteOnTermination
java.lang.String code
enable-volume-io.java.lang.String description
java.lang.String eventType
java.lang.String eventId
java.lang.String eventType
java.lang.String description
java.util.Date notBefore
java.util.Date notAfter
java.lang.String eventId
java.lang.String volumeId
java.lang.String availabilityZone
VolumeStatusInfo volumeStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
com.amazonaws.internal.ListWithAutoConstructFlag<T> actions
java.lang.String vpcId
java.lang.String state
Constraints:
Allowed Values: pending, available
java.lang.String cidrBlock
java.lang.String dhcpOptionsId
default if the default options are associated with the
VPC).com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String instanceTenancy
Constraints:
Allowed Values: default, dedicated
java.lang.Boolean isDefault
VpcPeeringConnectionVpcInfo accepterVpcInfo
java.util.Date expirationTime
VpcPeeringConnectionVpcInfo requesterVpcInfo
VpcPeeringConnectionStateReason status
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String vpcPeeringConnectionId
java.lang.String vpnConnectionId
java.lang.String state
Constraints:
Allowed Values: pending, available, deleting, deleted
java.lang.String customerGatewayConfiguration
pending or available state.java.lang.String type
Constraints:
Allowed Values: ipsec.1
java.lang.String customerGatewayId
java.lang.String vpnGatewayId
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> vgwTelemetry
VpnConnectionOptions options
com.amazonaws.internal.ListWithAutoConstructFlag<T> routes
java.lang.String vpnGatewayId
java.lang.String state
Constraints:
Allowed Values: pending, available, deleting, deleted
java.lang.String type
Constraints:
Allowed Values: ipsec.1
java.lang.String availabilityZone
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcAttachments
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String destinationCidrBlock
java.lang.String source
Constraints:
Allowed Values: Static
java.lang.String state
Constraints:
Allowed Values: pending, available, deleting, deleted
java.lang.String clusterArn
arn:aws:ecs namespace, followed by the
region of the cluster, the AWS account ID of the cluster owner, the
cluster namespace, and then the cluster name. For
example,
arn:aws:ecs:region:012345678910:cluster/test.java.lang.String clusterName
java.lang.String status
ACTIVE or
INACTIVE. ACTIVE indicates that you can
register container instances with the cluster and the associated
instances can accept tasks.java.lang.String containerArn
java.lang.String taskArn
java.lang.String name
java.lang.String lastStatus
java.lang.Integer exitCode
java.lang.String reason
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkBindings
java.lang.String name
name of one container
can be entered in the links of another container to
connect the containers.java.lang.String image
repository-url/image:tag.java.lang.Integer cpu
cpu units reserved for the container. A
container instance has 1,024 cpu units for every CPU
core.java.lang.Integer memory
com.amazonaws.internal.ListWithAutoConstructFlag<T> links
link parameter allows containers to communicate with
each other without the need for port mappings, using the
name parameter. For more information on linking Docker
containers, see https://docs.docker.com/userguide/dockerlinks/.com.amazonaws.internal.ListWithAutoConstructFlag<T> portMappings
java.lang.Boolean essential
essential parameter of a container is marked as
true, the failure of that container will stop the task.
If the essential parameter of a container is marked as
false, then its failure will not affect the rest of the
containers in a task.com.amazonaws.internal.ListWithAutoConstructFlag<T> entryPoint
ENTRYPOINT that is passed to the container. For more
information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint.com.amazonaws.internal.ListWithAutoConstructFlag<T> command
CMD that is passed to the container. For more
information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd.com.amazonaws.internal.ListWithAutoConstructFlag<T> environment
java.lang.String containerInstanceArn
arn:aws:ecs namespace, followed by the
region of the container instance, the AWS account ID of the container
instance owner, the container-instance namespace, and
then the container instance UUID. For example,
arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.java.lang.String ec2InstanceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> remainingResources
com.amazonaws.internal.ListWithAutoConstructFlag<T> registeredResources
java.lang.String status
ACTIVE or INACTIVE. ACTIVE
indicates that the container instance can accept tasks.java.lang.Boolean agentConnected
true if the agent is actually
connected to Amazon ECS. Registered instances with an agent that may
be unhealthy or stopped will return false, and instances
without a connected agent cannot accept placement request.Cluster cluster
Cluster cluster
java.lang.String cluster
java.lang.String containerInstance
arn:aws:ecs namespace, followed by the region of the
container instance, the AWS account ID of the container instance
owner, the container-instance namespace, and then the
container instance UUID. For example,
arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.java.lang.Boolean force
force parameter if you have several tasks running on a
container instance and you don't want to run StopTask for
each task before deregistering the container instance.ContainerInstance containerInstance
TaskDefinition taskDefinition
java.lang.String cluster
com.amazonaws.internal.ListWithAutoConstructFlag<T> containerInstances
TaskDefinition taskDefinition
java.lang.String cluster
com.amazonaws.internal.ListWithAutoConstructFlag<T> tasks
java.lang.String containerInstance
arn:aws:ecs
namespace, followed by the region of the container instance, the AWS
account ID of the container instance owner, the
container-instance namespace, and then the container
instance UUID. For example,
arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.java.lang.String nextToken
nextToken value returned from a previous paginated
ListClusters request where maxResults was
used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
nextToken value. This value is null when
there are no more results to return.java.lang.Integer maxResults
ListClusters in paginated output. When this parameter is
used, ListClusters only returns maxResults
results in a single page along with a nextToken response
element. The remaining results of the initial request can be seen by
sending another ListClusters request with the returned
nextToken value. This value can be between 1 and 100. If
this parameter is not used, then ListClusters returns up
to 100 results and a nextToken value if applicable.com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterArns
java.lang.String nextToken
nextToken value to include in a future
ListClusters request. When the results of a
ListClusters request exceed maxResults, this
value can be used to retrieve the next page of results. This value is
null when there are no more results to return.java.lang.String cluster
java.lang.String nextToken
nextToken value returned from a previous paginated
ListContainerInstances request where
maxResults was used and the results exceeded the value of
that parameter. Pagination continues from the end of the previous
results that returned the nextToken value. This value is
null when there are no more results to return.java.lang.Integer maxResults
ListContainerInstances in paginated output. When this
parameter is used, ListContainerInstances only returns
maxResults results in a single page along with a
nextToken response element. The remaining results of the
initial request can be seen by sending another
ListContainerInstances request with the returned
nextToken value. This value can be between 1 and 100. If
this parameter is not used, then ListContainerInstances
returns up to 100 results and a nextToken value if
applicable.com.amazonaws.internal.ListWithAutoConstructFlag<T> containerInstanceArns
java.lang.String nextToken
nextToken value to include in a future
ListContainerInstances request. When the results of a
ListContainerInstances request exceed
maxResults, this value can be used to retrieve the next
page of results. This value is null when there are no
more results to return.java.lang.String familyPrefix
ListTaskDefinitions results with. Specifying a
familyPrefix will limit the listed task definitions to
definitions that belong to that family.java.lang.String nextToken
nextToken value returned from a previous paginated
ListTaskDefinitions request where maxResults
was used and the results exceeded the value of that parameter.
Pagination continues from the end of the previous results that
returned the nextToken value. This value is
null when there are no more results to return.java.lang.Integer maxResults
ListTaskDefinitions in paginated output. When this
parameter is used, ListTaskDefinitions only returns
maxResults results in a single page along with a
nextToken response element. The remaining results of the
initial request can be seen by sending another
ListTaskDefinitions request with the returned
nextToken value. This value can be between 1 and 100. If
this parameter is not used, then ListTaskDefinitions
returns up to 100 results and a nextToken value if
applicable.com.amazonaws.internal.ListWithAutoConstructFlag<T> taskDefinitionArns
ListTaskDefintions request.java.lang.String nextToken
nextToken value to include in a future
ListTaskDefinitions request. When the results of a
ListTaskDefinitions request exceed
maxResults, this value can be used to retrieve the next
page of results. This value is null when there are no
more results to return.java.lang.String cluster
java.lang.String containerInstance
ListTasks
results with. Specifying a containerInstance will limit
the results to tasks that belong to that container instance.java.lang.String family
ListTasks results with. Specifying a family
will limit the results to tasks that belong to that family.java.lang.String nextToken
nextToken value returned from a previous paginated
ListTasks request where maxResults was used
and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the
nextToken value. This value is null when
there are no more results to return.java.lang.Integer maxResults
ListTasks
in paginated output. When this parameter is used,
ListTasks only returns maxResults results in
a single page along with a nextToken response element.
The remaining results of the initial request can be seen by sending
another ListTasks request with the returned
nextToken value. This value can be between 1 and 100. If
this parameter is not used, then ListTasks returns up to
100 results and a nextToken value if applicable.com.amazonaws.internal.ListWithAutoConstructFlag<T> taskArns
ListTasks request.java.lang.String nextToken
nextToken value to include in a future
ListTasks request. When the results of a
ListTasks request exceed maxResults, this
value can be used to retrieve the next page of results. This value is
null when there are no more results to return.java.lang.String bindIP
java.lang.Integer containerPort
java.lang.Integer hostPort
java.lang.String cluster
java.lang.String instanceIdentityDocument
java.lang.String instanceIdentityDocumentSignature
com.amazonaws.internal.ListWithAutoConstructFlag<T> totalResources
ContainerInstance containerInstance
java.lang.String family
family for a task definition, which
allows you to track multiple versions of the same task definition. You
can think of the family as a name for your task
definition.com.amazonaws.internal.ListWithAutoConstructFlag<T> containerDefinitions
TaskDefinition taskDefinition
java.lang.String name
CPU,
MEMORY, PORTS, or a user-defined resource.java.lang.String type
INTEGER,
DOUBLE, LONG, or STRINGSET.java.lang.Double doubleValue
doubleValue type is set, the value of the
resource must be a double precision floating-point type.java.lang.Long longValue
longValue type is set, the value of the resource
must be an extended precision floating-point type.java.lang.Integer integerValue
integerValue type is set, the value of the
resource must be an integer.com.amazonaws.internal.ListWithAutoConstructFlag<T> stringSetValue
stringSetValue type is set, the value of the
resource must be a string type.java.lang.String cluster
java.lang.String taskDefinition
family and revision
(family:revision) or full Amazon Resource Name (ARN) of
the task definition that you want to run.TaskOverride overrides
java.lang.Integer count
com.amazonaws.internal.ListWithAutoConstructFlag<T> tasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> failures
RunTask action are listed
here.java.lang.String cluster
java.lang.String taskDefinition
family and revision
(family:revision) or full Amazon Resource Name (ARN) of
the task definition that you want to start.TaskOverride overrides
com.amazonaws.internal.ListWithAutoConstructFlag<T> containerInstances
com.amazonaws.internal.ListWithAutoConstructFlag<T> tasks
com.amazonaws.internal.ListWithAutoConstructFlag<T> failures
StartTask action are listed
here.java.lang.String cluster
java.lang.String task
Task task
java.lang.String cluster
java.lang.String task
java.lang.String containerName
java.lang.String status
java.lang.Integer exitCode
java.lang.String reason
com.amazonaws.internal.ListWithAutoConstructFlag<T> networkBindings
java.lang.String cluster
java.lang.String task
java.lang.String status
java.lang.String reason
java.lang.String taskArn
java.lang.String clusterArn
java.lang.String taskDefinitionArn
java.lang.String containerInstanceArn
TaskOverride overrides
java.lang.String lastStatus
java.lang.String desiredStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> containers
java.lang.String taskDefinitionArn
com.amazonaws.internal.ListWithAutoConstructFlag<T> containerDefinitions
java.lang.String family
family as the name of your task definition.java.lang.Integer revision
1, and each time you register a task definition in the
same family, the revision value increases by one.java.lang.String cacheSecurityGroupName
java.lang.String eC2SecurityGroupName
java.lang.String eC2SecurityGroupOwnerId
java.lang.String cacheClusterId
Endpoint configurationEndpoint
java.lang.String clientDownloadLandingPage
java.lang.String cacheNodeType
java.lang.String engine
java.lang.String engineVersion
java.lang.String cacheClusterStatus
java.lang.Integer numCacheNodes
java.lang.String preferredAvailabilityZone
java.util.Date cacheClusterCreateTime
java.lang.String preferredMaintenanceWindow
PendingModifiedValues pendingModifiedValues
NotificationConfiguration notificationConfiguration
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroups
CacheParameterGroupStatus cacheParameterGroup
java.lang.String cacheSubnetGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodes
java.lang.Boolean autoMinorVersionUpgrade
true, then minor version patches are applied
automatically; if false, then automatic minor version
patches are disabled.com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
java.lang.String replicationGroupId
java.lang.Integer snapshotRetentionLimit
Important
If the value of SnapshotRetentionLimit is set
to zero (0), backups are turned off.
java.lang.String snapshotWindow
Example:
05:00-09:00
java.lang.String engine
java.lang.String engineVersion
java.lang.String cacheParameterGroupFamily
java.lang.String cacheEngineDescription
java.lang.String cacheEngineVersionDescription
java.lang.String cacheNodeId
java.lang.String cacheNodeStatus
java.util.Date cacheNodeCreateTime
Endpoint endpoint
java.lang.String parameterGroupStatus
java.lang.String sourceCacheNodeId
java.lang.String customerAvailabilityZone
java.lang.String parameterName
java.lang.String description
java.lang.String source
java.lang.String dataType
java.lang.String allowedValues
java.lang.Boolean isModifiable
true) or not (false) the
parameter can be modified. Some parameters have security or
operational implications that prevent them from being changed.java.lang.String minimumEngineVersion
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeTypeSpecificValues
java.lang.String cacheParameterGroupName
java.lang.String cacheParameterGroupFamily
java.lang.String description
java.lang.String cacheParameterGroupName
java.lang.String parameterApplyStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToReboot
java.lang.String ownerId
java.lang.String cacheSecurityGroupName
java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> eC2SecurityGroups
java.lang.String cacheSecurityGroupName
java.lang.String status
java.lang.String cacheSubnetGroupName
java.lang.String cacheSubnetGroupDescription
java.lang.String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
java.lang.String cacheClusterId
Constraints:
java.lang.String replicationGroupId
If the specified replication group is Automatic Failover enabled and the availability zone is not specified, the cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.
Note:
This parameter is only valid if the Engine parameter is
redis.
java.lang.String aZMode
This parameter is only supported for Memcached cache clusters.
If the AZMode and
PreferredAvailabilityZones are not specified, ElastiCache
assumes single-az mode.
Constraints:
Allowed Values: single-az, cross-az
java.lang.String preferredAvailabilityZone
All nodes belonging to this Memcached cache cluster are placed in
the preferred Availability Zone. If you want to create your nodes
across multiple Availability Zones, use
PreferredAvailabilityZones.
Default: System chosen Availability Zone.
com.amazonaws.internal.ListWithAutoConstructFlag<T> preferredAvailabilityZones
This option is
only supported on Memcached. If you are creating your cache
cluster in an Amazon VPC (recommended) you can only locate nodes in
Availability Zones that are associated with the subnets in the
selected subnet group. The number of Availability Zones listed must
equal the value of NumCacheNodes.
If you want
all the nodes in the same Availability Zone, use
PreferredAvailabilityZone instead, or repeat the
Availability Zone multiple times in the list.
Default: System chosen Availability Zones.
Example: One Memcached node in each of
three different Availability Zones:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1b&PreferredAvailabilityZones.member.3=us-east-1d
Example: All three Memcached nodes in one Availability Zone:
PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1a&PreferredAvailabilityZones.member.3=us-east-1a
java.lang.Integer numCacheNodes
For Memcached, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
For Redis, only single-node cache cluster are supported at this time, so the value for this parameter must be 1.
java.lang.String cacheNodeType
Valid node types are as follows:
cache.t2.micro,
cache.t2.small, cache.t2.medium,
cache.m3.medium, cache.m3.large,
cache.m3.xlarge, cache.m3.2xlargecache.t1.micro,
cache.m1.small, cache.m1.medium,
cache.m1.large, cache.m1.xlargecache.c1.xlargecache.r3.large, cache.r3.xlarge,
cache.r3.2xlarge, cache.r3.4xlarge,
cache.r3.8xlargecache.m2.xlarge, cache.m2.2xlarge,
cache.m2.4xlargeNotes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
java.lang.String engine
Valid values for this parameter are:
memcached |
redis
java.lang.String engineVersion
java.lang.String cacheParameterGroupName
java.lang.String cacheSubnetGroupName
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotArns
Note: This parameter is only valid if the
Engine parameter is redis.
Example of an
Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
java.lang.String snapshotName
restoring while the
new node group is being created. Note: This parameter is
only valid if the Engine parameter is redis.
java.lang.String preferredMaintenanceWindow
Example: sun:05:00-sun:09:00
java.lang.Integer port
java.lang.String notificationTopicArn
java.lang.Boolean autoMinorVersionUpgrade
true allows these upgrades to occur; false
disables automatic upgrades. Default: true
java.lang.Integer snapshotRetentionLimit
SnapshotRetentionLimit to 5, then a snapshot that was
taken today will be retained for 5 days before being deleted.
Note: This parameter is only valid if the
Engine parameter is redis.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
java.lang.String snapshotWindow
Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
Note: This parameter is only valid if the
Engine parameter is redis.
java.lang.String cacheParameterGroupName
java.lang.String cacheParameterGroupFamily
Valid values are: memcached1.4 |
redis2.6 | redis2.8
java.lang.String description
java.lang.String cacheSecurityGroupName
Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word "Default".
Example:
mysecuritygroup
java.lang.String description
java.lang.String cacheSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup
java.lang.String cacheSubnetGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
java.lang.String replicationGroupId
Constraints:
java.lang.String replicationGroupDescription
java.lang.String primaryClusterId
This parameter is not required if NumCacheClusters is specified.
java.lang.Boolean automaticFailoverEnabled
If
true, automatic failover is enabled for this replication
group. If false, automatic failover is disabled for this
replication group.
Default: false ElastiCache Multi-AZ
replication groups is not supported on:
java.lang.Integer numCacheClusters
If AutomaticFailover is enabled, the
value of this parameter must be at least 2.
The maximum permitted value for NumCacheClusters is 6 (primary plus 5 replicas). If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request forrm at http://aws.amazon.com/contact-us/elasticache-node-limit-request.
com.amazonaws.internal.ListWithAutoConstructFlag<T> preferredCacheClusterAZs
The number of availability zones listed must equal the value of NumCacheClusters.
Default: system chosen availability zones.
Example: One Redis cache cluster in each of three availability zones. PreferredAvailabilityZones.member.1=us-east-1a PreferredAvailabilityZones.member.2=us-east-1c PreferredAvailabilityZones.member.3=us-east-1d
java.lang.String cacheNodeType
Valid node types are as follows:
cache.t2.micro,
cache.t2.small, cache.t2.medium,
cache.m3.medium, cache.m3.large,
cache.m3.xlarge, cache.m3.2xlargecache.t1.micro,
cache.m1.small, cache.m1.medium,
cache.m1.large, cache.m1.xlargecache.c1.xlargecache.r3.large, cache.r3.xlarge,
cache.r3.2xlarge, cache.r3.4xlarge,
cache.r3.8xlargecache.m2.xlarge, cache.m2.2xlarge,
cache.m2.4xlargeNotes:
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
java.lang.String engine
Default: redis
java.lang.String engineVersion
java.lang.String cacheParameterGroupName
java.lang.String cacheSubnetGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (VPC).
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotArns
Note: This parameter is only valid if the
Engine parameter is redis.
Example of an
Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
java.lang.String snapshotName
restoring while the
new node group is being created. Note: This parameter is
only valid if the Engine parameter is redis.
java.lang.String preferredMaintenanceWindow
Example: sun:05:00-sun:09:00
java.lang.Integer port
java.lang.String notificationTopicArn
java.lang.Boolean autoMinorVersionUpgrade
true allows these upgrades to occur; false
disables automatic upgrades. Default: true
java.lang.Integer snapshotRetentionLimit
SnapshotRetentionLimit to 5, then a snapshot that was
taken today will be retained for 5 days before being deleted.
Note: This parameter is only valid if the
Engine parameter is redis.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
java.lang.String snapshotWindow
Example:
05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
Note: This parameter is only valid if the
Engine parameter is redis.
java.lang.String cacheClusterId
java.lang.String finalSnapshotIdentifier
java.lang.String replicationGroupId
java.lang.Boolean retainPrimaryCluster
java.lang.String finalSnapshotIdentifier
java.lang.String cacheClusterId
java.lang.Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
java.lang.String marker
java.lang.Boolean showCacheNodeInfo
java.lang.String engine
memcached |
redisjava.lang.String engineVersion
Example: 1.4.14
java.lang.String cacheParameterGroupFamily
Constraints:
java.lang.Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
java.lang.String marker
java.lang.Boolean defaultOnly
java.lang.String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheEngineVersions
java.lang.String cacheParameterGroupName
java.lang.Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
java.lang.String marker
java.lang.String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheParameterGroups
java.lang.String cacheParameterGroupName
java.lang.String source
Valid values: user |
system | engine-default
java.lang.Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
java.lang.String marker
java.lang.String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeTypeSpecificParameters
java.lang.String cacheSecurityGroupName
java.lang.Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
java.lang.String marker
java.lang.String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroups
java.lang.String cacheSubnetGroupName
java.lang.Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
java.lang.String marker
java.lang.String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSubnetGroups
java.lang.String cacheParameterGroupFamily
memcached1.4 | redis2.6 |
redis2.8java.lang.Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
java.lang.String marker
java.lang.String sourceIdentifier
java.lang.String sourceType
Valid values are: cache-cluster |
cache-parameter-group | cache-security-group
| cache-subnet-group
Constraints:
Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
java.util.Date startTime
java.util.Date endTime
java.lang.Integer duration
java.lang.Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
java.lang.String marker
java.lang.String replicationGroupId
If you do not specify this parameter, information about all replication groups is returned.
java.lang.Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
java.lang.String marker
java.lang.String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> replicationGroups
java.lang.String reservedCacheNodesOfferingId
Example:
438012d3-4052-4cc7-b2e3-8d3372e0e706
java.lang.String cacheNodeType
java.lang.String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
java.lang.String productDescription
java.lang.String offeringType
Valid
Values: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
java.lang.Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
java.lang.String marker
java.lang.String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedCacheNodesOfferings
java.lang.String reservedCacheNodeId
java.lang.String reservedCacheNodesOfferingId
java.lang.String cacheNodeType
java.lang.String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
java.lang.String productDescription
java.lang.String offeringType
Valid
values: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
java.lang.Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 100
Constraints: minimum 20; maximum 100.
java.lang.String marker
java.lang.String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedCacheNodes
java.lang.String cacheClusterId
java.lang.String snapshotName
java.lang.String snapshotSource
system, the output shows snapshots that were
automatically created by ElastiCache. If set to user the
output shows snapshots that were manually created. If omitted, the
output shows both automatically and manually created snapshots.java.lang.String marker
java.lang.Integer maxRecords
MaxRecords value, a
marker is included in the response so that the remaining results can
be retrieved. Default: 50
Constraints: minimum 20; maximum 50.
java.lang.String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshots
java.lang.String status
java.lang.String eC2SecurityGroupName
java.lang.String eC2SecurityGroupOwnerId
java.lang.String cacheParameterGroupFamily
java.lang.String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeTypeSpecificParameters
java.lang.String sourceIdentifier
java.lang.String sourceType
Constraints:
Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
java.lang.String message
java.util.Date date
java.lang.String cacheClusterId
java.lang.Integer numCacheNodes
NumCacheNodes is greater than the sum of the
number of current cache nodes and the number of cache nodes pending
creation (which may be zero), then more nodes will be added. If the
value is less than the number of existing cache nodes, then nodes will
be removed. If the value is equal to the number of current cache
nodes, then any pending add or remove requests are canceled. If you
are removing cache nodes, you must use the
CacheNodeIdsToRemove parameter to provide the IDs of the
specific cache nodes to remove.
For cache clusters running Redis,
the value of NumCacheNodesmust be 1.
Note:
Adding or removing Memcached cache nodes can be
applied immediately or as a pending action. See
ApplyImmediately.
A pending action to modify the
number of cache nodes in a cluster during its maintenance window,
whether by adding or removing nodes in accordance with the scale out
architecture, is not queued. The customer's latest request to add or
remove nodes to the cluster overrides any previous pending actions to
modify the number of cache nodes in the cluster. For example, a
request to remove 2 nodes would override a previous pending action to
remove 3 nodes. Similarly, a request to add 2 nodes would override a
previous pending action to remove 3 nodes and vice versa. As Memcached
cache nodes may now be provisioned in different Availability Zones
with flexible cache node placement, a request to add nodes does not
automatically override a previous pending action to add nodes. The
customer can modify the previous pending action to add more nodes or
explicitly cancel the pending request and retry the new request. To
cancel pending actions to modify the number of cache nodes in a
cluster, use the ModifyCacheCluster request and set
NumCacheNodes equal to the number of cache nodes
currently in the cache cluster.
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToRemove
For example: If you have 3
active cache nodes, 7 pending cache nodes, and the number of cache
nodes in this ModifyCacheCluser call is 5, you must list
2 (7 - 5) cache node IDs to remove.
java.lang.String aZMode
Valid values: single-az |
cross-az.
This option is only supported for Memcached
cache clusters. You cannot specify Only
newly created nodes will be located in different Availability Zones.
For instructions on how to move existing Memcached nodes to different
Availability Zones, see the Availability Zone Considerations
section of Cache
Node Considerations for Memcached. single-az if
the Memcached cache cluster already has cache nodes in different
Availability Zones. If cross-az is specified, existing
Memcached nodes remain in their current Availability Zone.
Constraints:
Allowed Values: single-az, cross-az
com.amazonaws.internal.ListWithAutoConstructFlag<T> newAvailabilityZones
This parameter is only valid when
NumCacheNodes in the request is greater than the sum of
the number of active cache nodes and the number of cache nodes pending
creation (which may be zero). The number of Availability Zones
supplied in this list must match the cache nodes being added in this
request.
This option is only supported on Memcached clusters.
Scenarios:
NumCacheNodes=5 (3 + 2)
and optionally specify two Availability Zones for the two new
nodes.NumCacheNodes=6 ((3 + 2) + 1)NumCacheNodes=3 to cancel all pending
actions.The Availability Zone placement of nodes
pending creation cannot be modified. If you wish to cancel any nodes
pending creation, add 0 nodes by setting NumCacheNodes to
the number of current nodes.
If cross-az is specified,
existing Memcached nodes remain in their current Availability Zone.
Only newly created nodes can be located in different Availability
Zones. For guidance on how to move existing Memcached nodes to
different Availability Zones, see the Availability Zone
Considerations section of Cache
Node Considerations for Memcached.
Impact of new add/remove requests upon pending requests
| Scenarios | Pending Operation | New Request | Results |
|---|---|---|---|
| Scenario-1 | Delete | Delete | The new delete, pending or immediate, replaces the pending delete. |
| Scenario-2 | Delete | Create | The new create, pending or immediate, replaces the pending delete. |
| Scenario-3 | Create | Delete | The new delete, pending or immediate, replaces the pending create. |
| Scenario-4 | Create | Create | The new
create is added to the pending create. Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending. |
Example:
NewAvailabilityZones.member.1=us-east-1a&NewAvailabilityZones.member.2=us-east-1b&NewAvailabilityZones.member.3=us-east-1d
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).
java.lang.String preferredMaintenanceWindow
java.lang.String notificationTopicArn
java.lang.String cacheParameterGroupName
java.lang.String notificationTopicStatus
Valid values:
active | inactive
java.lang.Boolean applyImmediately
true, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the cache cluster. If
false, then changes to the cache cluster are applied on
the next maintenance reboot, or the next failure reboot, whichever
occurs first. ModifyCacheCluster before a pending modification is
applied, the pending modification is replaced by the newer
modification.
Valid values: true |
false
Default: false
java.lang.String engineVersion
java.lang.Boolean autoMinorVersionUpgrade
true, then minor engine upgrades will be applied
automatically to the cache cluster during the maintenance window.
Valid values: true | false
Default:
true
java.lang.Integer snapshotRetentionLimit
Important
If the value of SnapshotRetentionLimit is set
to zero (0), backups are turned off.
java.lang.String snapshotWindow
java.lang.String cacheParameterGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterNameValues
java.lang.String cacheSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example:
mysubnetgroup
java.lang.String cacheSubnetGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
java.lang.String replicationGroupId
java.lang.String replicationGroupDescription
java.lang.String primaryClusterId
java.lang.String snapshottingClusterId
java.lang.Boolean automaticFailoverEnabled
Valid values:
ElastiCache Multi-AZ
replication groups is not supported on: true | false
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).
java.lang.String preferredMaintenanceWindow
java.lang.String notificationTopicArn
java.lang.String cacheParameterGroupName
java.lang.String notificationTopicStatus
Valid values: active | inactive
java.lang.Boolean applyImmediately
true, this parameter causes the modifications in this
request and any pending modifications to be applied, asynchronously
and as soon as possible, regardless of the
PreferredMaintenanceWindow setting for the replication group.
If false, then changes to the nodes in the replication
group are applied on the next maintenance reboot, or the next failure
reboot, whichever occurs first.
Valid values: true |
false
Default: false
java.lang.String engineVersion
java.lang.Boolean autoMinorVersionUpgrade
true allows these upgrades to occur;
false disables automatic upgrades.java.lang.Integer snapshotRetentionLimit
Important
If the value of SnapshotRetentionLimit is set
to zero (0), backups are turned off.
java.lang.String snapshotWindow
Example: 05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
java.lang.String nodeGroupId
java.lang.String status
Endpoint primaryEndpoint
com.amazonaws.internal.ListWithAutoConstructFlag<T> nodeGroupMembers
java.lang.String cacheClusterId
java.lang.String cacheNodeId
Endpoint readEndpoint
java.lang.String preferredAvailabilityZone
java.lang.String currentRole
java.lang.String cacheNodeId
java.lang.String cacheSize
java.util.Date cacheNodeCreateTime
java.util.Date snapshotCreateTime
java.lang.String parameterName
java.lang.String parameterValue
java.lang.String description
java.lang.String source
java.lang.String dataType
java.lang.String allowedValues
java.lang.Boolean isModifiable
true) or not (false) the
parameter can be modified. Some parameters have security or
operational implications that prevent them from being changed.java.lang.String minimumEngineVersion
java.lang.Integer numCacheNodes
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToRemove
java.lang.String engineVersion
java.lang.String reservedCacheNodesOfferingId
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
java.lang.String reservedCacheNodeId
Example: myreservationID
java.lang.Integer cacheNodeCount
Default:
1
java.lang.String cacheClusterId
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToReboot
java.lang.String replicationGroupId
java.lang.String description
java.lang.String status
ReplicationGroupPendingModifiedValues pendingModifiedValues
com.amazonaws.internal.ListWithAutoConstructFlag<T> memberClusters
com.amazonaws.internal.ListWithAutoConstructFlag<T> nodeGroups
java.lang.String snapshottingClusterId
java.lang.String automaticFailover
ElastiCache AutoFailover replication groups are not supported on:
Constraints:
Allowed Values: enabled, disabled, enabling, disabling
java.lang.String primaryClusterId
--apply-immediately was specified), or during the next
maintenance window.java.lang.String automaticFailoverStatus
ElastiCache AutoFailover replication groups are not supported on:
Constraints:
Allowed Values: enabled, disabled
java.lang.String reservedCacheNodeId
java.lang.String reservedCacheNodesOfferingId
java.lang.String cacheNodeType
java.util.Date startTime
java.lang.Integer duration
java.lang.Double fixedPrice
java.lang.Double usagePrice
java.lang.Integer cacheNodeCount
java.lang.String productDescription
java.lang.String offeringType
java.lang.String state
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
java.lang.String reservedCacheNodesOfferingId
java.lang.String cacheNodeType
java.lang.Integer duration
java.lang.Double fixedPrice
java.lang.Double usagePrice
java.lang.String productDescription
java.lang.String offeringType
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
java.lang.String cacheParameterGroupName
java.lang.Boolean resetAllParameters
Valid values: true | false
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterNameValues
java.lang.String cacheSecurityGroupName
java.lang.String eC2SecurityGroupName
java.lang.String eC2SecurityGroupOwnerId
java.lang.String securityGroupId
java.lang.String status
java.lang.String snapshotName
java.lang.String cacheClusterId
java.lang.String snapshotStatus
creating |
available | restoring | copying
| deleting.java.lang.String snapshotSource
automated) or was created manually
(manual).java.lang.String cacheNodeType
java.lang.String engine
java.lang.String engineVersion
java.lang.Integer numCacheNodes
java.lang.String preferredAvailabilityZone
java.util.Date cacheClusterCreateTime
java.lang.String preferredMaintenanceWindow
java.lang.String topicArn
java.lang.Integer port
java.lang.String cacheParameterGroupName
java.lang.String cacheSubnetGroupName
java.lang.String vpcId
java.lang.Boolean autoMinorVersionUpgrade
true) or not
(false).java.lang.Integer snapshotRetentionLimit
For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.
Important
If the value
of SnapshotRetentionLimit is set to zero (0), backups are turned off.
java.lang.String snapshotWindow
com.amazonaws.internal.ListWithAutoConstructFlag<T> nodeSnapshots
java.lang.String subnetIdentifier
AvailabilityZone subnetAvailabilityZone
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
java.util.Date dateCreated
java.util.Date dateUpdated
com.amazonaws.internal.ListWithAutoConstructFlag<T> versions
com.amazonaws.internal.ListWithAutoConstructFlag<T> configurationTemplates
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
java.lang.String versionLabel
Constraints:
Length: 1 - 100
S3Location sourceBundle
java.util.Date dateCreated
java.util.Date dateUpdated
java.lang.Boolean available
true : The CNAME is available.
true : The CNAME is not
available.
true :
The CNAME is available. false : The CNAME is
not available. java.lang.String fullyQualifiedCNAME
Constraints:
Length: 1 - 255
java.lang.String namespace
java.lang.String name
java.lang.String defaultValue
java.lang.String changeSeverity
NoInterruption - There is no interruption to the environment or application availability.
RestartEnvironment - The environment is restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.
RestartApplicationServer - The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
NoInterruption : There is no interruption to the
environment or application availability. RestartEnvironment : The environment is entirely
restarted, all AWS resources are deleted and recreated, and the
environment is unavailable during the process. RestartApplicationServer : The environment is available
the entire time. However, a short application outage occurs when the
application servers on the running Amazon EC2 instances are restarted.
java.lang.Boolean userDefined
true : This
configuration option was defined by the user. It is a valid choice for
specifying this as an Option to Remove when updating configuration
settings.
false : This
configuration was not defined by the user.
true : This configuration option was defined by
the user. It is a valid choice for specifying if this as an
Option to Remove when updating configuration settings.
false : This configuration was not defined by
the user. Constraint: You can remove only
UserDefined options from a configuration.
Valid
Values: true | false
java.lang.String valueType
Scalar : Values
for this option are a single selection from the possible values, or a
unformatted string or numeric value governed by the MIN/MAX/Regex
constraints:
List :
Values for this option are multiple selections of the possible values.
Boolean : Values for
this option are either true or false .
Scalar : Values for
this option are a single selection from the possible values, or an
unformatted string, or numeric value governed by the
MIN/MAX/Regex constraints. List :
Values for this option are multiple selections from the possible
values. Boolean : Values for this option are
either true or false .
Constraints:
Allowed Values: Scalar, List
com.amazonaws.internal.ListWithAutoConstructFlag<T> valueOptions
java.lang.Integer minValue
java.lang.Integer maxValue
java.lang.Integer maxLength
OptionRestrictionRegex regex
java.lang.String solutionStackName
Constraints:
Length: 0 - 100
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String templateName
null, the name of the configuration template for
this configuration set.
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
java.lang.String environmentName
null, the name of the environment for this
configuration set.
Constraints:
Length: 4 - 23
java.lang.String deploymentStatus
DeploymentStatus parameter indicates the deployment
status of this configuration set:
null: This configuration is not associated with a running
environment.
pending:
This is a draft configuration that is not deployed to the associated
environment but is in the process of deploying.
deployed: This is the configuration
that is currently deployed to the associated running environment.
failed: This is a
draft configuration, that failed to successfully deploy.
null: This configuration is not
associated with a running environment. pending: This is a draft configuration that is not
deployed to the associated environment but is in the process of
deploying. deployed: This is the configuration
that is currently deployed to the associated running environment.
failed: This is a draft configuration that
failed to successfully deploy.
Constraints:
Allowed Values: deployed, pending, failed
java.util.Date dateCreated
java.util.Date dateUpdated
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
java.lang.String applicationName
Constraint: This name must be unique
within your account. If the specified name already exists, the action
returns an InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
ApplicationDescription application
java.lang.String applicationName
AutoCreateApplication is false,
returns an InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String versionLabel
Constraint: Must be unique per
application. If an application version already exists with this label
for the specified application, AWS Elastic Beanstalk returns an
InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
S3Location sourceBundle
If data found at the Amazon S3 location
exceeds the maximum allowed source bundle size, AWS Elastic Beanstalk
returns an InvalidParameterValue error. The maximum size
allowed is 512 MB.
Default: If not specified, AWS Elastic Beanstalk
uses a sample application. If only partially specified (for example, a
bucket is provided but not the key) or if no data is found at the
Amazon S3 location, AWS Elastic Beanstalk returns an
InvalidParameterCombination error.
java.lang.Boolean autoCreateApplication
true: Automatically creates the specified application
for this version if it does not already exist.
false: Returns an
InvalidParameterValue if the specified application for
this version does not already exist.
true : Automatically creates the specified application
for this release if it does not already exist. false : Throws an InvalidParameterValue if
the specified application for this release does not already exist.
Default: false
Valid Values:
true | false
ApplicationVersionDescription applicationVersion
java.lang.String applicationName
InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String templateName
Constraint: This name must be unique per application.
Default: If a configuration template
already exists with this name, AWS Elastic Beanstalk returns an
InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String solutionStackName
Use ListAvailableSolutionStacks to obtain a list of available solution stacks.
A solution stack name or a source
configuration parameter must be specified, otherwise AWS Elastic
Beanstalk returns an InvalidParameterValue error.
If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.
Constraints:
Length: 0 - 100
SourceConfiguration sourceConfiguration
Values specified in the OptionSettings parameter of
this call overrides any values obtained from the
SourceConfiguration.
If no configuration template is
found, returns an InvalidParameterValue error.
Constraint: If both the solution stack name parameter and the source
configuration parameters are specified, the solution stack of the
source configuration template must match the specified solution stack
name or else AWS Elastic Beanstalk returns an
InvalidParameterCombination error.
java.lang.String environmentId
java.lang.String description
Constraints:
Length: 0 - 200
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
java.lang.String solutionStackName
Constraints:
Length: 0 - 100
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String templateName
null, the name of the configuration template for
this configuration set.
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
java.lang.String environmentName
null, the name of the environment for this
configuration set.
Constraints:
Length: 4 - 23
java.lang.String deploymentStatus
DeploymentStatus parameter indicates the deployment
status of this configuration set:
null: This configuration is not associated with a running
environment.
pending:
This is a draft configuration that is not deployed to the associated
environment but is in the process of deploying.
deployed: This is the configuration
that is currently deployed to the associated running environment.
failed: This is a
draft configuration, that failed to successfully deploy.
null: This configuration is not
associated with a running environment. pending: This is a draft configuration that is not
deployed to the associated environment but is in the process of
deploying. deployed: This is the configuration
that is currently deployed to the associated running environment.
failed: This is a draft configuration that
failed to successfully deploy.
Constraints:
Allowed Values: deployed, pending, failed
java.util.Date dateCreated
java.util.Date dateUpdated
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
java.lang.String applicationName
If no application is found with this name,
CreateEnvironment returns an
InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String environmentName
Constraint: Must be from 4 to 23 characters in length. The
name can contain only letters, numbers, and hyphens. It cannot start
or end with a hyphen. This name must be unique in your account. If the
specified name already exists, AWS Elastic Beanstalk returns an
InvalidParameterValue error.
Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
Constraints:
Length: 4 - 23
java.lang.String description
Constraints:
Length: 0 - 200
java.lang.String cNAMEPrefix
Constraints:
Length: 4 - 63
EnvironmentTier tier
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String versionLabel
If the specified
application has no associated application versions, AWS Elastic
Beanstalk UpdateEnvironment returns an
InvalidParameterValue error.
Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.
Constraints:
Length: 1 - 100
java.lang.String templateName
InvalidParameterValue error. Condition:
You must specify either this parameter or a
SolutionStackName, but not both. If you specify both, AWS
Elastic Beanstalk returns an InvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns a
MissingRequiredParameter error.
Constraints:
Length: 1 - 100
java.lang.String solutionStackName
Condition: You must specify either this or a
TemplateName, but not both. If you specify both, AWS
Elastic Beanstalk returns an InvalidParameterCombination
error. If you do not specify either, AWS Elastic Beanstalk returns a
MissingRequiredParameter error.
Constraints:
Length: 0 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToRemove
java.lang.String environmentName
Constraints:
Length: 4 - 23
java.lang.String environmentId
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String versionLabel
Constraints:
Length: 1 - 100
java.lang.String solutionStackName
SolutionStack deployed with this
environment.
Constraints:
Length: 0 - 100
java.lang.String templateName
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
java.lang.String endpointURL
java.lang.String cNAME
Constraints:
Length: 1 - 255
java.util.Date dateCreated
java.util.Date dateUpdated
java.lang.String status
Launching: Environment is in the process of initial
deployment. Updating: Environment is in the
process of updating its configuration settings or application version.
Ready: Environment is available to have an
action performed on it, such as update or terminate. Terminating: Environment is in the shut-down process.
Terminated: Environment is not running.
Constraints:
Allowed Values: Launching, Updating, Ready, Terminating, Terminated
java.lang.String health
Red : Indicates the environment is
not working.
Yellow:
Indicates that something is wrong, the application might not be
available, but the instances appear running.
Green: Indicates the environment is
healthy and fully functional.
Red: Indicates the environment is not responsive. Occurs
when three or more consecutive failures occur for an environment.
Yellow: Indicates that something is wrong.
Occurs when two consecutive failures occur for an environment. Green: Indicates the environment is healthy and
fully functional. Grey: Default health for a
new environment. The environment is not fully launched and health
checks have not started or health checks are suspended during an
UpdateEnvironment or RestartEnvironement
request. Default: Grey
Constraints:
Allowed Values: Green, Yellow, Red, Grey
EnvironmentResourcesDescription resources
EnvironmentTier tier
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String versionLabel
Constraints:
Length: 1 - 100
java.lang.Boolean deleteSourceBundle
true: An attempt is made to delete the
associated Amazon S3 source bundle specified at time of creation.
false: No action is taken on the Amazon S3
source bundle specified at time of creation. Valid
Values: true | false
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String environmentName
Constraints:
Length: 4 - 23
com.amazonaws.internal.ListWithAutoConstructFlag<T> applications
java.lang.String applicationName
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> versionLabels
com.amazonaws.internal.ListWithAutoConstructFlag<T> applicationVersions
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String templateName
Constraints:
Length: 1 - 100
java.lang.String environmentName
Constraints:
Length: 4 - 23
java.lang.String solutionStackName
Constraints:
Length: 0 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> options
java.lang.String solutionStackName
Constraints:
Length: 0 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> options
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String templateName
Conditional:
You must specify either this parameter or an EnvironmentName, but not
both. If you specify both, AWS Elastic Beanstalk returns an
InvalidParameterCombination error. If you do not specify
either, AWS Elastic Beanstalk returns a
MissingRequiredParameter error.
Constraints:
Length: 1 - 100
java.lang.String environmentName
Condition: You must
specify either this or a TemplateName, but not both. If you specify
both, AWS Elastic Beanstalk returns an
InvalidParameterCombination error. If you do not specify
either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
Constraints:
Length: 4 - 23
com.amazonaws.internal.ListWithAutoConstructFlag<T> configurationSettings
java.lang.String environmentId
Condition: You must specify either this or an EnvironmentName, or
both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
java.lang.String environmentName
Condition: You must specify either this or an EnvironmentId, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
Constraints:
Length: 4 - 23
EnvironmentResourceDescription environmentResources
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String versionLabel
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> environmentIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> environmentNames
java.lang.Boolean includeDeleted
true: Environments that have been deleted after
IncludedDeletedBackTo are displayed.
false: Do not include deleted environments.
java.util.Date includedDeletedBackTo
IncludeDeleted is set to
true, then environments deleted after this date are
displayed.com.amazonaws.internal.ListWithAutoConstructFlag<T> environments
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String versionLabel
Constraints:
Length: 1 - 100
java.lang.String templateName
Constraints:
Length: 1 - 100
java.lang.String environmentId
java.lang.String environmentName
Constraints:
Length: 4 - 23
java.lang.String requestId
java.lang.String severity
Constraints:
Allowed Values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL
java.util.Date startTime
java.util.Date endTime
EndTime.java.lang.Integer maxRecords
Constraints:
Range: 1 - 1000
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
java.lang.String nextToken
java.lang.String environmentName
Constraints:
Length: 4 - 23
java.lang.String environmentId
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String versionLabel
Constraints:
Length: 1 - 100
java.lang.String solutionStackName
SolutionStack deployed with this
environment.
Constraints:
Length: 0 - 100
java.lang.String templateName
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
java.lang.String endpointURL
java.lang.String cNAME
Constraints:
Length: 1 - 255
java.util.Date dateCreated
java.util.Date dateUpdated
java.lang.String status
Launching: Environment is in the process of initial
deployment. Updating: Environment is in the
process of updating its configuration settings or application version.
Ready: Environment is available to have an
action performed on it, such as update or terminate. Terminating: Environment is in the shut-down process.
Terminated: Environment is not running.
Constraints:
Allowed Values: Launching, Updating, Ready, Terminating, Terminated
java.lang.String health
Red : Indicates the environment is
not working.
Yellow:
Indicates that something is wrong, the application might not be
available, but the instances appear running.
Green: Indicates the environment is
healthy and fully functional.
Red: Indicates the environment is not responsive. Occurs
when three or more consecutive failures occur for an environment.
Yellow: Indicates that something is wrong.
Occurs when two consecutive failures occur for an environment. Green: Indicates the environment is healthy and
fully functional. Grey: Default health for a
new environment. The environment is not fully launched and health
checks have not started or health checks are suspended during an
UpdateEnvironment or RestartEnvironement
request. Default: Grey
Constraints:
Allowed Values: Green, Yellow, Red, Grey
EnvironmentResourcesDescription resources
EnvironmentTier tier
java.lang.String infoType
Constraints:
Allowed Values: tail
java.lang.String ec2InstanceId
java.util.Date sampleTimestamp
java.lang.String message
java.lang.String environmentName
Constraints:
Length: 4 - 23
com.amazonaws.internal.ListWithAutoConstructFlag<T> autoScalingGroups
AutoScalingGroups used by this environment.com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
com.amazonaws.internal.ListWithAutoConstructFlag<T> launchConfigurations
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancers
com.amazonaws.internal.ListWithAutoConstructFlag<T> triggers
AutoScaling triggers in use by this environment.com.amazonaws.internal.ListWithAutoConstructFlag<T> queues
LoadBalancerDescription loadBalancer
java.util.Date eventDate
java.lang.String message
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String versionLabel
Constraints:
Length: 1 - 100
java.lang.String templateName
Constraints:
Length: 1 - 100
java.lang.String environmentName
Constraints:
Length: 4 - 23
java.lang.String requestId
java.lang.String severity
Constraints:
Allowed Values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL
com.amazonaws.internal.ListWithAutoConstructFlag<T> solutionStacks
com.amazonaws.internal.ListWithAutoConstructFlag<T> solutionStackDetails
java.lang.String environmentId
Condition: You must specify
either this or an EnvironmentName, or both. If you do not specify
either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
java.lang.String environmentName
Condition: You must
specify either this or an EnvironmentId, or both. If you do not
specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
Constraints:
Length: 4 - 23
java.lang.String environmentId
If no such
environment is found, RequestEnvironmentInfo returns an
InvalidParameterValue error.
Condition: You must
specify either this or an EnvironmentName, or both. If you do not
specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
java.lang.String environmentName
If no such
environment is found, RequestEnvironmentInfo returns an
InvalidParameterValue error.
Condition: You must
specify either this or an EnvironmentId, or both. If you do not
specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
Constraints:
Length: 4 - 23
java.lang.String infoType
Constraints:
Allowed Values: tail
java.lang.String environmentId
Condition:
You must specify either this or an EnvironmentName, or both. If you do
not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
java.lang.String environmentName
Condition:
You must specify either this or an EnvironmentId, or both. If you do
not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
Constraints:
Length: 4 - 23
java.lang.String environmentId
If no such environment is found,
returns an InvalidParameterValue error.
Condition:
You must specify either this or an EnvironmentName, or both. If you do
not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
java.lang.String environmentName
If no such environment is
found, returns an InvalidParameterValue error.
Condition: You must specify either this or an EnvironmentId, or both.
If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
Constraints:
Length: 4 - 23
java.lang.String infoType
Constraints:
Allowed Values: tail
com.amazonaws.internal.ListWithAutoConstructFlag<T> environmentInfo
java.lang.String sourceEnvironmentId
Condition: You must specify at
least the SourceEnvironmentID or the
SourceEnvironmentName. You may also specify both. If you
specify the SourceEnvironmentId, you must specify the
DestinationEnvironmentId.
java.lang.String sourceEnvironmentName
Condition: You must specify at
least the SourceEnvironmentID or the
SourceEnvironmentName. You may also specify both. If you
specify the SourceEnvironmentName, you must specify the
DestinationEnvironmentName.
Constraints:
Length: 4 - 23
java.lang.String destinationEnvironmentId
Condition: You must specify
at least the DestinationEnvironmentID or the
DestinationEnvironmentName. You may also specify both.
You must specify the SourceEnvironmentId with the
DestinationEnvironmentId.
java.lang.String destinationEnvironmentName
Condition: You must
specify at least the DestinationEnvironmentID or the
DestinationEnvironmentName. You may also specify both.
You must specify the SourceEnvironmentName with the
DestinationEnvironmentName.
Constraints:
Length: 4 - 23
java.lang.String environmentId
Condition: You must
specify either this or an EnvironmentName, or both. If you do not
specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
java.lang.String environmentName
Condition: You must
specify either this or an EnvironmentId, or both. If you do not
specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
Constraints:
Length: 4 - 23
java.lang.Boolean terminateResources
true: (default) The user AWS resources (for example, the
Auto Scaling group, LoadBalancer, etc.) are terminated along with the
environment.
false: The
environment is removed from the AWS Elastic Beanstalk but the AWS
resources continue to operate.
true: The specified environment as well as the associated
AWS resources, such as Auto Scaling group and LoadBalancer, are
terminated. false: AWS Elastic Beanstalk
resource management is removed from the environment, but the AWS
resources continue to operate. For more information, see the AWS Elastic Beanstalk User Guide.
Default: true
Valid Values: true | false
java.lang.String environmentName
Constraints:
Length: 4 - 23
java.lang.String environmentId
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String versionLabel
Constraints:
Length: 1 - 100
java.lang.String solutionStackName
SolutionStack deployed with this
environment.
Constraints:
Length: 0 - 100
java.lang.String templateName
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
java.lang.String endpointURL
java.lang.String cNAME
Constraints:
Length: 1 - 255
java.util.Date dateCreated
java.util.Date dateUpdated
java.lang.String status
Launching: Environment is in the process of initial
deployment. Updating: Environment is in the
process of updating its configuration settings or application version.
Ready: Environment is available to have an
action performed on it, such as update or terminate. Terminating: Environment is in the shut-down process.
Terminated: Environment is not running.
Constraints:
Allowed Values: Launching, Updating, Ready, Terminating, Terminated
java.lang.String health
Red : Indicates the environment is
not working.
Yellow:
Indicates that something is wrong, the application might not be
available, but the instances appear running.
Green: Indicates the environment is
healthy and fully functional.
Red: Indicates the environment is not responsive. Occurs
when three or more consecutive failures occur for an environment.
Yellow: Indicates that something is wrong.
Occurs when two consecutive failures occur for an environment. Green: Indicates the environment is healthy and
fully functional. Grey: Default health for a
new environment. The environment is not fully launched and health
checks have not started or health checks are suspended during an
UpdateEnvironment or RestartEnvironement
request. Default: Grey
Constraints:
Allowed Values: Green, Yellow, Red, Grey
EnvironmentResourcesDescription resources
EnvironmentTier tier
java.lang.String applicationName
UpdateApplication returns an
InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String description
Default: If not specified, AWS Elastic Beanstalk does not update the description.
Constraints:
Length: 0 - 200
ApplicationDescription application
java.lang.String applicationName
If no
application is found with this name, UpdateApplication
returns an InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String versionLabel
If no application version is
found with this label, UpdateApplication returns an
InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
ApplicationVersionDescription applicationVersion
java.lang.String applicationName
If no application is found with this name,
UpdateConfigurationTemplate returns an
InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String templateName
If no
configuration template is found with this name,
UpdateConfigurationTemplate returns an
InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToRemove
Constraint: You can remove only UserDefined
configuration options.
java.lang.String solutionStackName
Constraints:
Length: 0 - 100
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String templateName
null, the name of the configuration template for
this configuration set.
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
java.lang.String environmentName
null, the name of the environment for this
configuration set.
Constraints:
Length: 4 - 23
java.lang.String deploymentStatus
DeploymentStatus parameter indicates the deployment
status of this configuration set:
null: This configuration is not associated with a running
environment.
pending:
This is a draft configuration that is not deployed to the associated
environment but is in the process of deploying.
deployed: This is the configuration
that is currently deployed to the associated running environment.
failed: This is a
draft configuration, that failed to successfully deploy.
null: This configuration is not
associated with a running environment. pending: This is a draft configuration that is not
deployed to the associated environment but is in the process of
deploying. deployed: This is the configuration
that is currently deployed to the associated running environment.
failed: This is a draft configuration that
failed to successfully deploy.
Constraints:
Allowed Values: deployed, pending, failed
java.util.Date dateCreated
java.util.Date dateUpdated
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
java.lang.String environmentId
If no environment with this
ID exists, AWS Elastic Beanstalk returns an
InvalidParameterValue error.
Condition: You must
specify either this or an EnvironmentName, or both. If you do not
specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
java.lang.String environmentName
InvalidParameterValue error. Condition: You must
specify either this or an EnvironmentId, or both. If you do not
specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter error.
Constraints:
Length: 4 - 23
java.lang.String description
Constraints:
Length: 0 - 200
EnvironmentTier tier
Condition: You can only update the tier version for an environment. If
you change the name of the type, AWS Elastic Beanstalk returns
InvalidParameterValue error.
java.lang.String versionLabel
InvalidParameterValue error.
Constraints:
Length: 1 - 100
java.lang.String templateName
InvalidParameterValue error.
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToRemove
java.lang.String environmentName
Constraints:
Length: 4 - 23
java.lang.String environmentId
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String versionLabel
Constraints:
Length: 1 - 100
java.lang.String solutionStackName
SolutionStack deployed with this
environment.
Constraints:
Length: 0 - 100
java.lang.String templateName
Constraints:
Length: 1 - 100
java.lang.String description
Constraints:
Length: 0 - 200
java.lang.String endpointURL
java.lang.String cNAME
Constraints:
Length: 1 - 255
java.util.Date dateCreated
java.util.Date dateUpdated
java.lang.String status
Launching: Environment is in the process of initial
deployment. Updating: Environment is in the
process of updating its configuration settings or application version.
Ready: Environment is available to have an
action performed on it, such as update or terminate. Terminating: Environment is in the shut-down process.
Terminated: Environment is not running.
Constraints:
Allowed Values: Launching, Updating, Ready, Terminating, Terminated
java.lang.String health
Red : Indicates the environment is
not working.
Yellow:
Indicates that something is wrong, the application might not be
available, but the instances appear running.
Green: Indicates the environment is
healthy and fully functional.
Red: Indicates the environment is not responsive. Occurs
when three or more consecutive failures occur for an environment.
Yellow: Indicates that something is wrong.
Occurs when two consecutive failures occur for an environment. Green: Indicates the environment is healthy and
fully functional. Grey: Default health for a
new environment. The environment is not fully launched and health
checks have not started or health checks are suspended during an
UpdateEnvironment or RestartEnvironement
request. Default: Grey
Constraints:
Allowed Values: Green, Yellow, Red, Grey
EnvironmentResourcesDescription resources
EnvironmentTier tier
java.lang.String applicationName
Constraints:
Length: 1 - 100
java.lang.String templateName
Condition: You cannot specify both this and an environment name.
Constraints:
Length: 1 - 100
java.lang.String environmentName
Condition: You cannot specify both this and a configuration template name.
Constraints:
Length: 4 - 23
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> messages
java.lang.String message
java.lang.String severity
error: This message indicates that this is not a valid setting for an option.
warning: This message is providing information you should take into account.
Constraints:
Allowed Values: error, warning
java.lang.String namespace
java.lang.String optionName
java.lang.Boolean enabled
java.lang.String s3BucketName
java.lang.Integer emitInterval
Default: 60 minutes
java.lang.String s3BucketPrefix
my-bucket-prefix/prod. If the prefix is not
provided, the log is placed at the root level of the bucket.com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Constraints:
Length: 1 -
java.lang.String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
java.lang.String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
java.lang.String loadBalancerName
HealthCheck healthCheck
HealthCheck healthCheck
java.lang.String loadBalancerName
java.lang.String policyName
java.lang.String cookieName
java.lang.String loadBalancerName
java.lang.String policyName
java.lang.Long cookieExpirationPeriod
java.lang.String loadBalancerName
java.lang.String policyName
java.lang.String policyTypeName
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyAttributes
java.lang.String loadBalancerName
The name must be unique within your set of load balancers, must have a maximum of 32 characters, and must only contain alphanumeric characters or hyphens.
com.amazonaws.internal.ListWithAutoConstructFlag<T> listeners
For information about the protocols and the ports supported by Elastic Load Balancing, see Listener Configurations for Elastic Load Balancing.
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
At least one Availability Zone must be specified. Specified Availability Zones must be in the same EC2 Region as the load balancer. Traffic will be equally distributed across all zones.
You can later add more Availability Zones after the creation of the load balancer by calling EnableAvailabilityZonesForLoadBalancer action.
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
java.lang.String scheme
By default, Elastic Load Balancing creates an Internet-facing load balancer with a publicly resolvable DNS name, which resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Internet-facing and Internal Load Balancers.
Specify the value
This option is only available for load balancers created within
EC2-VPC. internal for this option to create an internal load
balancer with a DNS name that resolves to private IP addresses.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
For more information about setting tags for your load balancer, see Tagging.
Constraints:
Length: 1 -
LoadBalancerAttributes loadBalancerAttributes
java.lang.String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyTypeDescriptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
java.lang.String marker
java.lang.Integer pageSize
Constraints:
Range: 1 - 400
java.lang.String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
java.lang.String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
java.lang.String target
TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case a healthcheck simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.
SSL is also specified as SSL: port pair, for example, SSL:5000.
For HTTP or HTTPS protocol, the situation is different. You have to include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
The total length of the HTTP ping target needs to be 1024 16-bit Unicode characters or less.
java.lang.Integer interval
Constraints:
Range: 1 - 300
java.lang.Integer timeout
Constraints:
Range: 1 - 300
java.lang.Integer unhealthyThreshold
Constraints:
Range: 2 - 10
java.lang.Integer healthyThreshold
Constraints:
Range: 2 - 10
java.lang.String instanceId
java.lang.String state
Valid value:
InService|OutOfService|Unknown
java.lang.String reasonCode
Valid value:
ELB|Instance|N/A
java.lang.String description
java.lang.String policyName
java.lang.Long cookieExpirationPeriod
java.lang.String protocol
java.lang.Integer loadBalancerPort
java.lang.String instanceProtocol
InstanceProtocol has to be at the same
protocol layer, i.e., HTTP or HTTPS. Likewise, if the front-end
protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL. InstancePort whose InstanceProtocol is
secure, i.e., HTTPS or SSL, the listener's
InstanceProtocol has to be secure, i.e., HTTPS or SSL. If
there is another listener with the same InstancePort
whose InstanceProtocol is HTTP or TCP, the listener's
InstanceProtocol must be either HTTP or TCP. java.lang.Integer instancePort
Constraints:
Range: 1 - 65535
java.lang.String sSLCertificateId
Listener listener
For information about the protocols and the ports supported by Elastic Load Balancing, see Listener Configurations for Elastic Load Balancing.
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
CrossZoneLoadBalancing crossZoneLoadBalancing
For more information, see Enable Cross-Zone Load Balancing.
AccessLog accessLog
For more information, see Enable Access Logs.
ConnectionDraining connectionDraining
For more information, see Enable Connection Draining.
ConnectionSettings connectionSettings
By default, Elastic Load
Balancing maintains a 60-second idle connection timeout for both
front-end and back-end connections of your load balancer. If the
ConnectionSettings attribute is set, Elastic Load
Balancing will allow the connections to remain idle (no data is sent
over the connection) for the specified duration.
For more information, see Configure Idle Connection Timeout.
com.amazonaws.internal.ListWithAutoConstructFlag<T> additionalAttributes
java.lang.String loadBalancerName
java.lang.String dNSName
java.lang.String canonicalHostedZoneName
java.lang.String canonicalHostedZoneNameID
com.amazonaws.internal.ListWithAutoConstructFlag<T> listenerDescriptions
Policies policies
com.amazonaws.internal.ListWithAutoConstructFlag<T> backendServerDescriptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
java.lang.String vPCId
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
HealthCheck healthCheck
SourceSecurityGroup sourceSecurityGroup
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
java.util.Date createdTime
java.lang.String scheme
If the Scheme is
internet-facing, the load balancer has a publicly
resolvable DNS name that resolves to public IP addresses.
If the
Scheme is internal, the load balancer has a
publicly resolvable DNS name that resolves to private IP addresses.
This option is only available for load balancers attached to an Amazon VPC.
java.lang.String loadBalancerName
LoadBalancerAttributes loadBalancerAttributes
java.lang.String loadBalancerName
LoadBalancerAttributes loadBalancerAttributes
LoadBalancerAttributes data type.com.amazonaws.internal.ListWithAutoConstructFlag<T> appCookieStickinessPolicies
com.amazonaws.internal.ListWithAutoConstructFlag<T> lBCookieStickinessPolicies
com.amazonaws.internal.ListWithAutoConstructFlag<T> otherPolicies
java.lang.String attributeName
java.lang.String attributeType
java.lang.String description
java.lang.String defaultValue
java.lang.String cardinality
java.lang.String policyName
java.lang.String policyTypeName
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyAttributeDescriptions
java.lang.String policyTypeName
java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyAttributeTypeDescriptions
java.lang.String loadBalancerName
com.amazonaws.internal.ListWithAutoConstructFlag<T> instances
com.amazonaws.internal.ListWithAutoConstructFlag<T> loadBalancerNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Constraints:
Length: 1 -
java.lang.String loadBalancerName
java.lang.Integer loadBalancerPort
java.lang.String sSLCertificateId
java.lang.String loadBalancerName
java.lang.Integer instancePort
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
java.lang.String loadBalancerName
java.lang.Integer loadBalancerPort
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
java.lang.String ownerAlias
--source-group-user parameter of the
ec2-authorize command in the Amazon EC2 command line
tool.java.lang.String groupName
--source-group parameter of the
ec2-authorize command in the Amazon EC2 command line
tool.com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceGroups
java.lang.String jobFlowId
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String jobFlowId
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceGroupIds
java.lang.String jobFlowId
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> steps
java.lang.String resourceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String name
java.lang.String version
com.amazonaws.internal.ListWithAutoConstructFlag<T> args
java.util.Map<K,V> additionalInfo
java.lang.String name
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
ScriptBootstrapActionConfig scriptBootstrapAction
BootstrapActionConfig bootstrapActionConfig
java.lang.String id
java.lang.String name
ClusterStatus status
Ec2InstanceAttributes ec2InstanceAttributes
java.lang.String logUri
java.lang.String requestedAmiVersion
java.lang.String runningAmiVersion
java.lang.Boolean autoTerminate
java.lang.Boolean terminationProtected
java.lang.Boolean visibleToAllUsers
true, all IAM users of that AWS account can view and
manage the job flow if they have the proper policy permissions set. If
this value is false, only the IAM user that created the
cluster can view and manage it. This value can be changed using the
SetVisibleToAllUsers action.com.amazonaws.internal.ListWithAutoConstructFlag<T> applications
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String serviceRole
java.lang.Integer normalizedInstanceHours
java.lang.String masterPublicDnsName
java.lang.String code
Constraints:
Allowed Values: INTERNAL_ERROR, VALIDATION_ERROR, INSTANCE_FAILURE, BOOTSTRAP_FAILURE, USER_REQUEST, STEP_FAILURE, ALL_STEPS_COMPLETED
java.lang.String message
java.lang.String state
Constraints:
Allowed Values: STARTING, BOOTSTRAPPING, RUNNING, WAITING, TERMINATING, TERMINATED, TERMINATED_WITH_ERRORS
ClusterStateChangeReason stateChangeReason
ClusterTimeline timeline
java.lang.String id
java.lang.String name
ClusterStatus status
java.lang.Integer normalizedInstanceHours
java.util.Date creationDateTime
java.util.Date readyDateTime
java.util.Date endDateTime
Cluster cluster
java.util.Date createdAfter
java.util.Date createdBefore
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobFlowIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobFlowStates
Step step
java.lang.String ec2KeyName
java.lang.String ec2SubnetId
Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus, you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a VPC.
java.lang.String ec2AvailabilityZone
java.lang.String iamInstanceProfile
com.amazonaws.internal.ListWithAutoConstructFlag<T> properties
java.lang.String jar
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String mainClass
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> args
java.lang.String jar
java.util.Map<K,V> properties
java.lang.String mainClass
com.amazonaws.internal.ListWithAutoConstructFlag<T> args
java.lang.String id
java.lang.String ec2InstanceId
java.lang.String publicDnsName
java.lang.String publicIpAddress
java.lang.String privateDnsName
java.lang.String privateIpAddress
InstanceStatus status
java.lang.String id
java.lang.String name
java.lang.String market
Constraints:
Allowed Values: ON_DEMAND, SPOT
java.lang.String instanceGroupType
Constraints:
Allowed Values: MASTER, CORE, TASK
java.lang.String bidPrice
java.lang.String instanceType
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer requestedInstanceCount
java.lang.Integer runningInstanceCount
InstanceGroupStatus status
java.lang.String name
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String market
Constraints:
Allowed Values: ON_DEMAND, SPOT
java.lang.String instanceRole
Constraints:
Allowed Values: MASTER, CORE, TASK
java.lang.String bidPrice
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String instanceType
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer instanceCount
java.lang.String instanceGroupId
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String name
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String market
Constraints:
Allowed Values: ON_DEMAND, SPOT
java.lang.String instanceRole
Constraints:
Allowed Values: MASTER, CORE, TASK
java.lang.String bidPrice
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String instanceType
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer instanceRequestCount
java.lang.Integer instanceRunningCount
java.lang.String state
Constraints:
Allowed Values: PROVISIONING, BOOTSTRAPPING, RUNNING, RESIZING, SUSPENDED, TERMINATING, TERMINATED, ARRESTED, SHUTTING_DOWN, ENDED
java.lang.String lastStateChangeReason
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.util.Date creationDateTime
java.util.Date startDateTime
java.util.Date readyDateTime
java.util.Date endDateTime
java.lang.String instanceGroupId
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer instanceCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> eC2InstanceIdsToTerminate
java.lang.String state
Constraints:
Allowed Values: PROVISIONING, BOOTSTRAPPING, RUNNING, RESIZING, SUSPENDED, TERMINATING, TERMINATED, ARRESTED, SHUTTING_DOWN, ENDED
InstanceGroupStateChangeReason stateChangeReason
InstanceGroupTimeline timeline
java.util.Date creationDateTime
java.util.Date readyDateTime
java.util.Date endDateTime
java.lang.String state
Constraints:
Allowed Values: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING, TERMINATED
InstanceStateChangeReason stateChangeReason
InstanceTimeline timeline
java.util.Date creationDateTime
java.util.Date readyDateTime
java.util.Date endDateTime
java.lang.String jobFlowId
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String name
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String logUri
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String amiVersion
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
JobFlowExecutionStatusDetail executionStatusDetail
JobFlowInstancesDetail instances
com.amazonaws.internal.ListWithAutoConstructFlag<T> steps
com.amazonaws.internal.ListWithAutoConstructFlag<T> bootstrapActions
com.amazonaws.internal.ListWithAutoConstructFlag<T> supportedProducts
java.lang.Boolean visibleToAllUsers
true, all IAM users of that AWS account can view and (if
they have the proper policy permissions set) manage the job flow. If
it is set to false, only the IAM user that created the
job flow can view and manage it. This value can be changed using the
SetVisibleToAllUsers action.java.lang.String jobFlowRole
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String serviceRole
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String state
Constraints:
Allowed Values: STARTING, BOOTSTRAPPING, RUNNING, WAITING, SHUTTING_DOWN, TERMINATED, COMPLETED, FAILED
java.util.Date creationDateTime
java.util.Date startDateTime
java.util.Date readyDateTime
java.util.Date endDateTime
java.lang.String lastStateChangeReason
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String masterInstanceType
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String slaveInstanceType
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer instanceCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceGroups
java.lang.String ec2KeyName
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
PlacementType placement
java.lang.Boolean keepJobFlowAliveWhenNoSteps
java.lang.Boolean terminationProtected
java.lang.String hadoopVersion
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String ec2SubnetId
Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a Amazon VPC.
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String masterInstanceType
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String masterPublicDnsName
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String masterInstanceId
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String slaveInstanceType
Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.Integer instanceCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceGroups
java.lang.Integer normalizedInstanceHours
java.lang.String ec2KeyName
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String ec2SubnetId
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
PlacementType placement
java.lang.Boolean keepJobFlowAliveWhenNoSteps
java.lang.Boolean terminationProtected
java.lang.String hadoopVersion
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String key
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String value
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.util.Date createdAfter
java.util.Date createdBefore
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterStates
java.lang.String marker
java.lang.String clusterId
java.lang.String instanceGroupId
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceGroupTypes
java.lang.String marker
java.lang.String clusterId
com.amazonaws.internal.ListWithAutoConstructFlag<T> stepStates
com.amazonaws.internal.ListWithAutoConstructFlag<T> stepIds
java.lang.String marker
java.lang.String name
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String logUri
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String additionalInfo
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String amiVersion
If the AMI supports
multiple versions of Hadoop (for example, AMI 1.0 supports both Hadoop
0.18 and 0.20) you can use the JobFlowInstancesConfig
HadoopVersion parameter to modify the version of Hadoop
from the defaults shown above.
For details about the AMI versions currently supported by Amazon Elastic MapReduce, go to AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer's Guide.
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
JobFlowInstancesConfig instances
com.amazonaws.internal.ListWithAutoConstructFlag<T> steps
com.amazonaws.internal.ListWithAutoConstructFlag<T> bootstrapActions
com.amazonaws.internal.ListWithAutoConstructFlag<T> supportedProducts
com.amazonaws.internal.ListWithAutoConstructFlag<T> newSupportedProducts
java.lang.Boolean visibleToAllUsers
true, all IAM users of that AWS account can view and (if
they have the proper policy permissions set) manage the job flow. If
it is set to false, only the IAM user that created the
job flow can view and manage it.java.lang.String jobFlowRole
EMRJobflowDefault. In
order to use the default role, you must have already created it using
the CLI.
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String serviceRole
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String path
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> args
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobFlowIds
java.lang.Boolean terminationProtected
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobFlowIds
java.lang.Boolean visibleToAllUsers
java.lang.String id
java.lang.String name
HadoopStepConfig config
java.lang.String actionOnFailure
Constraints:
Allowed Values: TERMINATE_JOB_FLOW, TERMINATE_CLUSTER, CANCEL_AND_WAIT, CONTINUE
StepStatus status
java.lang.String name
Constraints:
Length: 0 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String actionOnFailure
Constraints:
Allowed Values: TERMINATE_JOB_FLOW, TERMINATE_CLUSTER, CANCEL_AND_WAIT, CONTINUE
HadoopJarStepConfig hadoopJarStep
StepConfig stepConfig
StepExecutionStatusDetail executionStatusDetail
java.lang.String state
Constraints:
Allowed Values: PENDING, RUNNING, CONTINUE, COMPLETED, CANCELLED, FAILED, INTERRUPTED
java.util.Date creationDateTime
java.util.Date startDateTime
java.util.Date endDateTime
java.lang.String lastStateChangeReason
Constraints:
Length: 0 - 10280
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
java.lang.String state
Constraints:
Allowed Values: PENDING, RUNNING, COMPLETED, CANCELLED, FAILED, INTERRUPTED
StepStateChangeReason stateChangeReason
StepTimeline timeline
java.lang.String id
java.lang.String name
HadoopStepConfig config
java.lang.String actionOnFailure
Constraints:
Allowed Values: TERMINATE_JOB_FLOW, TERMINATE_CLUSTER, CANCEL_AND_WAIT, CONTINUE
StepStatus status
java.util.Date creationDateTime
java.util.Date startDateTime
java.util.Date endDateTime
java.lang.String key
java.lang.String value
java.lang.String inputKey
PipelineId; the
InputBucket object in that pipeline identifies the
bucket. If the file name includes a prefix, for example,
cooking/pie.jpg, include the prefix in the key. If the
file isn't in the specified bucket, Elastic Transcoder returns an
error.
Constraints:
Length: 1 - 255
Pattern: (^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)
java.lang.String maxWidth
auto, Elastic Transcoder uses 600 as the default value.
If you specify a numeric value, enter an even integer between 32 and
4096, inclusive.
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
java.lang.String maxHeight
auto, Elastic Transcoder uses 600 as the default value.
If you specify a numeric value, enter an even integer between 32 and
3072, inclusive.
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
java.lang.String sizingPolicy
Fit: Elastic Transcoder scales
the output art so it matches the value that you specified in either
MaxWidth or MaxHeight without exceeding the
other value.Fill: Elastic Transcoder scales the
output art so it matches the value that you specified in either
MaxWidth or MaxHeight and matches or exceeds
the other value. Elastic Transcoder centers the output art and then
crops it in the dimension (if any) that exceeds the maximum value.
Stretch: Elastic Transcoder stretches the
output art to match the values that you specified for
MaxWidth and MaxHeight. If the relative
proportions of the input art and the output art are different, the
output art will be distorted.Keep: Elastic
Transcoder does not scale the output art. If either dimension of the
input art exceeds the values that you specified for
MaxWidth and MaxHeight, Elastic Transcoder
crops the output art.ShrinkToFit: Elastic
Transcoder scales the output art down so that its dimensions match the
values that you specified for at least one of MaxWidth
and MaxHeight without exceeding either value. If you
specify this option, Elastic Transcoder does not scale the art
up.ShrinkToFill Elastic Transcoder scales the
output art down so that its dimensions match the values that you
specified for at least one of MaxWidth and
MaxHeight without dropping below either value. If you
specify this option, Elastic Transcoder does not scale the art
up.
Constraints:
Pattern: (^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)
java.lang.String paddingPolicy
PaddingPolicy to Pad, Elastic
Transcoder may add white bars to the top and bottom and/or left and
right sides of the output album art to make the total size of the
output art match the values that you specified for
MaxWidth and MaxHeight.
Constraints:
Pattern: (^Pad$)|(^NoPad$)
java.lang.String albumArtFormat
.jpg
and .png.
Constraints:
Pattern: (^jpg$)|(^png$)
Encryption encryption
java.lang.String profile
Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles:
auto: If you specify auto, Elastic
Transcoder will select the profile based on the bit rate selected for
the output file.AAC-LC: The most common AAC
profile. Use for bit rates larger than 64 kbps.HE-AAC: Not supported on some older players and
devices. Use for bit rates between 40 and 80 kbps.HE-AACv2: Not supported on some players and devices.
Use for bit rates less than 48 kbps.All outputs in a
If you created any presets before AAC
profiles were added, Elastic Transcoder automatically updated your
presets to use AAC-LC. You can change the value as required.Smooth playlist must have the same value for
Profile.
Constraints:
Pattern: (^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)
java.lang.String codec
aac, mp3, and vorbis.
Constraints:
Pattern: (^AAC$)|(^vorbis$)|(^mp3$)
java.lang.String sampleRate
auto, 22050,
32000, 44100, 48000,
96000
If you specify auto, Elastic
Transcoder automatically detects the sample rate.
Constraints:
Pattern: (^auto$)|(^22050$)|(^32000$)|(^44100$)|(^48000$)|(^96000$)
java.lang.String bitRate
Constraints:
Pattern: ^\d{1,3}$
java.lang.String channels
auto, 0, 1, 2
If you specify auto, Elastic Transcoder automatically
detects the number of channels in the input file.
Constraints:
Pattern: (^auto$)|(^0$)|(^1$)|(^2$)
AudioCodecOptions codecOptions
AAC for Audio:Codec, this
is the AAC compression profile to use. Valid values
include: auto, AAC-LC,
HE-AAC, HE-AACv2
If you specify
auto, Elastic Transcoder chooses a profile based on the
bit rate of the output file.
java.lang.String id
To get a list of
the jobs (including their jobId) that have a status of
Submitted, use the ListJobsByStatus API action.
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String format
Valid Embedded Caption Formats:
For MP3: None
For MP4: mov-text
For MPEG-TS: None
For ogg: None
For webm: None
Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
For FMP4: dfxp
Non-FMP4 outputs: All sidecar types
fmp4 captions have an extension of .ismt
Constraints:
Pattern: (^mov-text$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)
java.lang.String pattern
{language}, where: {language} is a literal value that Elastic Transcoder
replaces with the two- or three-letter code for the language of the
caption in the output file names.If you don't include
{language} in the file name pattern, Elastic Transcoder
automatically appends "{language}" to the value that you
specify for the description. In addition, Elastic Transcoder
automatically appends the count to the end of the segment files.
For example, suppose you're transcoding into srt format. When you enter "Sydney-{language}-sunrise", and the language of the captions is English (en), the name of the first caption file will be Sydney-en-sunrise00000.srt.
Constraints:
Pattern: (^$)|(^.*\{language\}.*$)
Encryption encryption
java.lang.String mergePolicy
MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.
MergeRetain: Elastic Transcoder transcodes both embedded
and sidecar captions into outputs. If captions for a language are
embedded in the input file and also appear in a sidecar file, Elastic
Transcoder uses the embedded captions and ignores the sidecar captions
for that language. If CaptionSources is empty, Elastic
Transcoder omits all sidecar captions from the output files.
Override: Elastic Transcoder transcodes only the sidecar
captions that you specify in CaptionSources.
MergePolicy cannot be null.
Constraints:
Pattern: (^MergeOverride$)|(^MergeRetain$)|(^Override$)
com.amazonaws.internal.ListWithAutoConstructFlag<T> captionSources
CaptionSources blank.
Constraints:
Length: 0 - 20
com.amazonaws.internal.ListWithAutoConstructFlag<T> captionFormats
Constraints:
Length: 0 - 4
java.lang.String key
Constraints:
Length: 1 - 255
java.lang.String language
2-character ISO 639-1 code
3-character ISO 639-2 code
For more information on ISO language codes and language names, see the List of ISO 639-1 codes.
Constraints:
Length: 1 - 255
java.lang.String timeOffset
TimeOffset tells Elastic
Transcoder how much of the video to encode before including captions.
Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
Constraints:
Pattern: (^[+-]?\d{1,5}(\.\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\.\d{0,3})?$)
java.lang.String label
Constraints:
Length: 1 - 40
Encryption encryption
TimeSpan timeSpan
java.lang.String key
OutputBucket object in the pipeline that is specified by
the pipeline ID. If a file with the specified name already exists in
the output bucket, the job fails.
Constraints:
Length: 1 - 255
java.lang.String thumbnailPattern
If you don't want Elastic Transcoder to create thumbnails, specify "".
If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
{count} (Required): If you want to
create thumbnails, you must include {count} in the
ThumbnailPattern object. Wherever you specify
{count}, Elastic Transcoder adds a five-digit sequence
number (beginning with 00001) to thumbnail file names. The
number indicates where a given thumbnail appears in the sequence of
thumbnails for a transcoded file. {resolution} but you omit
{count}, Elastic Transcoder returns a validation error
and does not create the job.
Literal
values (Optional): You can specify literal values anywhere in the
ThumbnailPattern object. For example, you can include
them as a file name prefix or as a delimiter between
{resolution} and {count}.
{resolution} (Optional): If you want Elastic
Transcoder to include the resolution in the file name, include
{resolution} in the ThumbnailPattern object.
When creating thumbnails, Elastic Transcoder
automatically saves the files in the format (.jpg or .png) that
appears in the preset that you specified in the PresetID
value of CreateJobOutput. Elastic Transcoder also appends
the applicable file name extension.
Constraints:
Pattern: (^$)|(^.*\{count\}.*$)
Encryption thumbnailEncryption
java.lang.String rotate
auto, 0, 90,
180, 270. The value auto
generally works only if the file that you're transcoding contains
rotation metadata.
Constraints:
Pattern: (^auto$)|(^0$)|(^90$)|(^180$)|(^270$)
java.lang.String presetId
Id of the preset to use for this job. The preset
determines the audio, video, and thumbnail settings that Elastic
Transcoder uses for transcoding.
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String segmentDuration
PresetId for
which the value of Container is fmp4
(Fragmented MP4) or ts (MPEG-TS),
SegmentDuration is the target maximum duration of each
segment in seconds. For HLSv3 format playlists, each
media segment is stored in a separate .ts file. For
HLSv4 and Smooth playlists, all media
segments for an output are stored in a single file. Each segment is
approximately the length of the SegmentDuration, though
individual segments might be shorter or longer. The range of valid
values is 1 to 60 seconds. If the duration of the video is not evenly
divisible by SegmentDuration, the duration of the last
segment is the remainder of total length/SegmentDuration.
Elastic
Transcoder creates an output-specific playlist for each output
HLS output that you specify in OutputKeys. To add an
output to the master playlist for this job, include it in the
OutputKeys of the associated playlist.
Constraints:
Pattern: ^\d{1,5}(\.\d{0,5})?$
com.amazonaws.internal.ListWithAutoConstructFlag<T> watermarks
JobAlbumArt albumArt
com.amazonaws.internal.ListWithAutoConstructFlag<T> composition
Captions captions
Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.
Valid input values include: CEA-608
(EIA-608, first non-empty channel only), CEA-708
(EIA-708, first non-empty channel only), and
mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.
Valid input values include:
dfxp (first div element only), ebu-tt,
scc, smpt, srt,
ttml (first div element only), and webvtt
Valid outputs include: dfxp (first div element only),
scc, srt, and webvtt.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.
To remove captions or
leave the captions empty, set Captions to null. To pass
through existing captions unchanged, set the MergePolicy
to MergeRetain, and pass in a null
CaptionSources array.
For more information on embedded files, see the Subtitles Wikipedia page.
For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
Encryption encryption
java.lang.String name
/ character, the section of the name before the last
/ must be identical for all Name objects. If
you create more than one master playlist, the values of all
Name objects must be unique. Note: Elastic
Transcoder automatically appends the relevant file extension to the
file name (.m3u8 for HLSv3 and
HLSv4 playlists, and .ism and
.ismc for Smooth playlists). If you include
a file extension in Name, the file name will have two
extensions.
Constraints:
Length: 1 - 255
java.lang.String format
HLSv3, HLSv4, and Smooth.
Constraints:
Pattern: (^HLSv3$)|(^HLSv4$)|(^Smooth$)
com.amazonaws.internal.ListWithAutoConstructFlag<T> outputKeys
Outputs:Key object. If your output is not HLS or does not have a segment
duration set, the name of the output file is a concatenation of
OutputKeyPrefix and Outputs:Key:
OutputKeyPrefixOutputs:Key
If your
output is HLSv3 and has a segment duration set, or is not
included in a playlist, Elastic Transcoder creates an output playlist
file with a file extension of .m3u8, and a series of
.ts files that include a five-digit sequential counter
beginning with 00000:
OutputKeyPrefixOutputs:Key.m3u8
OutputKeyPrefixOutputs:Key00000.ts
If
your output is HLSv4, has a segment duration set, and is
included in an HLSv4 playlist, Elastic Transcoder creates
an output playlist file with a file extension of
_v4.m3u8. If the output is video, Elastic Transcoder also
creates an output file with an extension of _iframe.m3u8:
OutputKeyPrefixOutputs:Key_v4.m3u8
OutputKeyPrefixOutputs:Key_iframe.m3u8
OutputKeyPrefixOutputs:Key.ts
Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.
If you include more than one output
in a playlist, any segment duration settings, clip settings, or
caption settings must be the same for all outputs in the playlist. For
Smooth playlists, the Audio:Profile,
Video:Profile, and Video:FrameRate to
Video:KeyframesMaxDist ratio must be the same for all
outputs.
Constraints:
Length: 0 - 30
HlsContentProtection hlsContentProtection
java.lang.String pipelineId
Id of the pipeline that you want Elastic Transcoder
to use for transcoding. The pipeline determines several settings,
including the Amazon S3 bucket from which Elastic Transcoder gets the
files to transcode and the bucket into which Elastic Transcoder puts
the transcoded files.
Constraints:
Pattern: ^\d{13}-\w{6}$
JobInput input
CreateJobOutput output
CreateJobOutput structure.com.amazonaws.internal.ListWithAutoConstructFlag<T> outputs
Outputs syntax instead of the Output syntax.
Constraints:
Length: 0 - 30
java.lang.String outputKeyPrefix
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> playlists
PresetId for which the value
of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS),
Playlists contains information about the master playlists that you
want Elastic Transcoder to create. The maximum number of master playlists in a job is 30.
Constraints:
Length: 0 - 30
java.util.Map<K,V> userMetadata
key/value pairs,
and you can add up to 10 key/value pairs per job. Elastic
Transcoder does not guarantee that key/value pairs will
be returned in the same order in which you specify them.Job job
java.lang.String name
Constraints: Maximum 40 characters.
Constraints:
Length: 1 - 40
java.lang.String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
java.lang.String outputBucket
Specify this value when all of the following are true:
OutputBucket, it grants full control over the files only
to the AWS account that owns the role that is specified by
Role.If you want to save transcoded files and
playlists in one bucket and thumbnails in another bucket, specify
which users can access the transcoded files or the permissions the
users have, or change the Amazon S3 storage class, omit
OutputBucket and specify values for
ContentConfig and ThumbnailConfig instead.
Constraints:
Pattern: ^(\w|\.|-){1,255}$
java.lang.String role
Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$
java.lang.String awsKmsKeyArn
If you use either S3 or
S3-AWS-KMS as your Encryption:Mode, you
don't need to provide a key with your job because a default key, known
as an AWS-KMS key, is created for you automatically. You need to
provide an AWS-KMS key only if you want to use a non-default AWS-KMS
key, or if you are using an Encryption:Mode of
AES-PKCS7, AES-CTR, or AES-GCM.
Constraints:
Length: 0 - 255
Notifications notifications
PipelineOutputConfig contentConfig
ContentConfig object specifies information
about the Amazon S3 bucket in which you want Elastic Transcoder to
save transcoded files and playlists: which bucket to use, which users
you want to have access to the files, the type of access you want
users to have, and the storage class that you want to assign to the
files. If you specify values for ContentConfig, you
must also specify values for ThumbnailConfig.
If you
specify values for ContentConfig and
ThumbnailConfig, omit the OutputBucket
object.
Grantee object: Grantee object is either the canonical user ID for an
AWS account or an origin access identity for an Amazon CloudFront
distribution. For more information about canonical user IDs, see
Access Control List (ACL) Overview in the Amazon Simple Storage
Service Developer Guide. For more information about using CloudFront
origin access identities to require that users use CloudFront URLs
instead of Amazon S3 URLs, see Using an Origin Access Identity to
Restrict Access to Your Amazon S3 Content. Grantee object is the
registered email address of an AWS account.Grantee object is one of the following
predefined Amazon S3 groups: AllUsers,
AuthenticatedUsers, or LogDelivery.Grantee. Permissions are
granted on the files that Elastic Transcoder adds to the bucket,
including playlists and video files. Valid values include: READ: The grantee can read the objects and metadata
for objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP: The grantee can read the object ACL for
objects that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the
objects that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL: The grantee has READ,
READ_ACP, and WRITE_ACP permissions for the
objects that Elastic Transcoder adds to the Amazon S3 bucket.Standard or ReducedRedundancy, that you want
Elastic Transcoder to assign to the video files and playlists that it
stores in your Amazon S3 bucket.PipelineOutputConfig thumbnailConfig
ThumbnailConfig object specifies several values,
including the Amazon S3 bucket in which you want Elastic Transcoder to
save thumbnail files, which users you want to have access to the
files, the type of access you want users to have, and the storage
class that you want to assign to the files. If you specify values
for ContentConfig, you must also specify values for
ThumbnailConfig even if you don't want to create
thumbnails.
If you specify values for ContentConfig
and ThumbnailConfig, omit the OutputBucket
object.
Permissions object
specifies which users and/or predefined Amazon S3 groups you want to
have access to thumbnail files, and the type of access you want them
to have. You can grant permissions to a maximum of 30 users and/or
predefined Amazon S3 groups.Grantee object is
either the canonical user ID for an AWS account or an origin access
identity for an Amazon CloudFront distribution. Grantee object is the
registered email address of an AWS account. Grantee object is one of the following
predefined Amazon S3 groups: AllUsers,
AuthenticatedUsers, or LogDelivery.Grantee. Permissions are granted on
the thumbnail files that Elastic Transcoder adds to the bucket. Valid
values include: READ: The grantee can read the
thumbnails and metadata for objects that Elastic Transcoder adds to
the Amazon S3 bucket.READ_ACP: The grantee can
read the object ACL for thumbnails that Elastic Transcoder adds to the
Amazon S3 bucket. WRITE_ACP: The grantee can
write the ACL for the thumbnails that Elastic Transcoder adds to the
Amazon S3 bucket.FULL_CONTROL: The grantee has
READ, READ_ACP, and WRITE_ACP
permissions for the thumbnails that Elastic Transcoder adds to the
Amazon S3 bucket. Standard or
ReducedRedundancy, that you want Elastic Transcoder to
assign to the thumbnails that it stores in your Amazon S3 bucket.Pipeline pipeline
java.lang.String name
Constraints:
Length: 1 - 40
java.lang.String description
Constraints:
Length: 0 - 255
java.lang.String container
fmp4, mp3, mp4,
ogg, ts, and webm.
Constraints:
Pattern: (^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)|(^fmp4$)
VideoParameters video
AudioParameters audio
Thumbnails thumbnails
Preset preset
java.lang.String warning
java.lang.String mode
S3: Amazon S3 creates and manages the keys used for encrypting your files.
S3-AWS-KMS: Amazon S3 calls
the Amazon Key Management Service, which creates and manages the keys
that are used for encrypting your files. If you specify
S3-AWS-KMS and you don't want to use the default key, you
must add the AWS-KMS key that you want to use to your pipeline.
AES-CBC-PKCS7: A padded cipher-block mode of operation originally used for HLS files.
AES-CTR: AES Counter Mode.
AES-GCM: AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with will fail the decryption process.
For all three AES options, you must provide the following settings, which must be base64-encoded:
Key
Key MD5
Initialization Vector
For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data.
Constraints:
Pattern: (^s3$)|(^s3-aws-kms$)|(^aes-cbc-pkcs7$)|(^aes-ctr$)|(^aes-gcm$)
java.lang.String key
128,
192, or 256.
The key must also be encrypted by using the Amazon Key Management Service.
Constraints:
Pattern: ^$|(^(?:[A-Za-z0-9\+/]{4})*(?:[A-Za-z0-9\+/]{2}==|[A-Za-z0-9\+/]{3}=)?$)
java.lang.String keyMd5
Constraints:
Pattern: ^$|(^(?:[A-Za-z0-9\+/]{4})*(?:[A-Za-z0-9\+/]{2}==|[A-Za-z0-9\+/]{3}=)?$)
java.lang.String initializationVector
Constraints:
Length: 0 - 255
java.lang.String method
aes-128. This value will be written into the
method attribute of the EXT-X-KEY metadata tag in the
output playlist.
Constraints:
Pattern: (^aes-128$)
java.lang.String key
If you choose to supply your own key, you must encrypt the key by using AWS KMS. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded:
128, 192, or 256.
Constraints:
Pattern: ^$|(^(?:[A-Za-z0-9\+/]{4})*(?:[A-Za-z0-9\+/]{2}==|[A-Za-z0-9\+/]{3}=)?$)
java.lang.String keyMd5
The MD5 digest of the key that you want Elastic Transcoder to use to encrypt your output file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64- encoded.
Constraints:
Pattern: ^$|(^(?:[A-Za-z0-9\+/]{4})*(?:[A-Za-z0-9\+/]{2}==|[A-Za-z0-9\+/]{3}=)?$)
java.lang.String initializationVector
The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded.
Constraints:
Length: 0 - 255
java.lang.String licenseAcquisitionUrl
Constraints:
Length: 0 - 512
java.lang.String keyStoragePolicy
WithVariantPlaylists, LicenseAcquisitionUrl
must be left blank and Elastic Transcoder writes your data key into
the same bucket as the associated playlist.
Constraints:
Pattern: (^NoStore$)|(^WithVariantPlaylists$)
java.lang.String id
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String arn
java.lang.String pipelineId
Id of the pipeline that you want Elastic Transcoder
to use for transcoding. The pipeline determines several settings,
including the Amazon S3 bucket from which Elastic Transcoder gets the
files to transcode and the bucket into which Elastic Transcoder puts
the transcoded files.
Constraints:
Pattern: ^\d{13}-\w{6}$
JobInput input
JobOutput output
com.amazonaws.internal.ListWithAutoConstructFlag<T> outputs
Outputs syntax for all jobs, even when you want Elastic
Transcoder to transcode a file into only one format. Do not use both
the Outputs and Output syntaxes in the same
request. You can create a maximum of 30 outputs per job. If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.
java.lang.String outputKeyPrefix
OutputKeyPrefix.
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> playlists
PresetId for
which the value of Container is fmp4 (Fragmented MP4) or
ts (MPEG-TS), Playlists contains information about the
master playlists that you want Elastic Transcoder to create. The maximum number of master playlists in a job is 30.
java.lang.String status
Submitted,
Progressing, Complete,
Canceled, or Error.
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
java.util.Map<K,V> userMetadata
key/value pairs,
and you can add up to 10 key/value pairs per job. Elastic
Transcoder does not guarantee that key/value pairs will
be returned in the same order in which you specify them. Metadata
keys and values must use characters from the
following list:
0-9
A-Z and a-z
Space
The following symbols:
_.:/=+-%@
java.lang.String mergePolicy
Replace: The specified album art will replace any
existing album art.Prepend: The specified album
art will be placed in front of any existing album art.Append: The specified album art will be placed after
any existing album art.Fallback: If the
original input file contains artwork, Elastic Transcoder will use that
artwork for the output. If the original input does not contain
artwork, Elastic Transcoder will use the specified album art
file.
Constraints:
Pattern: (^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)
com.amazonaws.internal.ListWithAutoConstructFlag<T> artwork
.jpg and .pngjava.lang.String key
InputBucket object in that pipeline tells Elastic
Transcoder which Amazon S3 bucket to get the file from. If the file
name includes a prefix, such as cooking/lasagna.mpg,
include the prefix in the key. If the file isn't in the specified
bucket, Elastic Transcoder returns an error.
Constraints:
Length: 1 - 255
java.lang.String frameRate
auto. If you want to specify the frame rate for the input
file, enter one of the following values: 10,
15, 23.97, 24, 25,
29.97, 30, 60
If you specify
a value other than auto, Elastic Transcoder disables
automatic detection of the frame rate.
Constraints:
Pattern: (^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)
java.lang.String resolution
auto, which causes Elastic Transcoder
to automatically detect the resolution of the input file.
Constraints:
Pattern: (^auto$)|(^\d{1,5}x\d{1,5}$)
java.lang.String aspectRatio
auto. If you want to specify the aspect ratio for the
output file, enter one of the following values: 1:1,
4:3, 3:2, 16:9
If you
specify a value other than auto, Elastic Transcoder
disables automatic detection of the aspect ratio.
Constraints:
Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)
java.lang.String interlaced
auto. If you want to specify whether the input file is
interlaced, enter one of the following values: true,
false
If you specify a value other than
auto, Elastic Transcoder disables automatic detection of
interlacing.
Constraints:
Pattern: (^auto$)|(^true$)|(^false$)
java.lang.String container
auto. If you want to specify the container type for the
input file, enter one of the following values: 3gp,
aac, asf, avi,
divx, flv, m4a,
mkv, mov, mp3,
mp4, mpeg, mpeg-ps,
mpeg-ts, mxf, ogg,
vob, wav, webm
Constraints:
Pattern: (^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)|(^mp3$)|(^m4a$)|(^aac$)
Encryption encryption
java.lang.String id
java.lang.String key
OutputBucket object in the pipeline that is specified by
the pipeline ID.
Constraints:
Length: 1 - 255
java.lang.String thumbnailPattern
If you don't want Elastic Transcoder to create thumbnails, specify "".
If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
{count} (Required): If you want to
create thumbnails, you must include {count} in the
ThumbnailPattern object. Wherever you specify
{count}, Elastic Transcoder adds a five-digit sequence
number (beginning with 00001) to thumbnail file names. The
number indicates where a given thumbnail appears in the sequence of
thumbnails for a transcoded file. {resolution} but you omit
{count}, Elastic Transcoder returns a validation error
and does not create the job.
Literal
values (Optional): You can specify literal values anywhere in the
ThumbnailPattern object. For example, you can include
them as a file name prefix or as a delimiter between
{resolution} and {count}.
{resolution} (Optional): If you want Elastic
Transcoder to include the resolution in the file name, include
{resolution} in the ThumbnailPattern object.
When creating thumbnails, Elastic Transcoder
automatically saves the files in the format (.jpg or .png) that
appears in the preset that you specified in the PresetID
value of CreateJobOutput. Elastic Transcoder also appends
the applicable file name extension.
Constraints:
Pattern: (^$)|(^.*\{count\}.*$)
Encryption thumbnailEncryption
java.lang.String rotate
auto, 0, 90,
180, 270
The value auto
generally works only if the file that you're transcoding contains
rotation metadata.
Constraints:
Pattern: (^auto$)|(^0$)|(^90$)|(^180$)|(^270$)
java.lang.String presetId
Id object for the preset that you want
to use for this job. The preset determines the audio, video, and
thumbnail settings that Elastic Transcoder uses for transcoding. To
use a preset that you created, specify the preset ID that Elastic
Transcoder returned in the response when you created the preset. You
can also use the Elastic Transcoder system presets, which you can get
with ListPresets.
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String segmentDuration
PresetId for
which the value of Container is fmp4
(Fragmented MP4) or ts (MPEG-TS),
SegmentDuration is the target maximum duration of each
segment in seconds. For HLSv3 format playlists, each
media segment is stored in a separate .ts file. For
HLSv4 and Smooth playlists, all media
segments for an output are stored in a single file. Each segment is
approximately the length of the SegmentDuration, though
individual segments might be shorter or longer. The range of valid
values is 1 to 60 seconds. If the duration of the video is not evenly
divisible by SegmentDuration, the duration of the last
segment is the remainder of total length/SegmentDuration.
Elastic
Transcoder creates an output-specific playlist for each output
HLS output that you specify in OutputKeys. To add an
output to the master playlist for this job, include it in the
OutputKeys of the associated playlist.
Constraints:
Pattern: ^\d{1,5}(\.\d{0,5})?$
java.lang.String status
Outputs:Status is always the same as
Job:Status. If you specified more than one output: Job:Status and Outputs:Status for all of
the outputs is Submitted until Elastic Transcoder starts to process
the first output.Outputs:Status for that output and
Job:Status both change to Progressing. For each output,
the value of Outputs:Status remains Submitted until
Elastic Transcoder starts to process the output.Job:Status changes to Complete only if
Outputs:Status for all of the outputs is
Complete. If Outputs:Status for one or more
outputs is Error, the terminal status for
Job:Status is also Error.Status is one of the following:
Submitted, Progressing,
Complete, Canceled, or Error.
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
java.lang.String statusDetail
Status.
Constraints:
Length: 0 - 255
java.lang.Long duration
java.lang.Integer width
java.lang.Integer height
com.amazonaws.internal.ListWithAutoConstructFlag<T> watermarks
Preset for the
current output. Watermarks are added to the output video in the sequence in which you list them in the job output???the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add will cover the first one, the third one will cover the second, and the fourth one will cover the third.
JobAlbumArt albumArt
com.amazonaws.internal.ListWithAutoConstructFlag<T> composition
Captions captions
Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.
Valid input values include: CEA-608
(EIA-608, first non-empty channel only), CEA-708
(EIA-708, first non-empty channel only), and
mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.
Valid input values include:
dfxp (first div element only), ebu-tt,
scc, smpt, srt,
ttml (first div element only), and webvtt
Valid outputs include: dfxp (first div element only),
scc, srt, and webvtt.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.
To remove captions or
leave the captions empty, set Captions to null. To pass
through existing captions unchanged, set the MergePolicy
to MergeRetain, and pass in a null
CaptionSources array.
For more information on embedded files, see the Subtitles Wikipedia page.
For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
Encryption encryption
java.lang.String presetWatermarkId
Constraints:
Length: 1 - 40
java.lang.String inputKey
Pipeline; the Input Bucket object in that
pipeline identifies the bucket. If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.
Constraints:
Length: 1 - 255
Pattern: (^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)
Encryption encryption
java.lang.String pipelineId
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String ascending
true. To list jobs in reverse
chronological order, enter false.
Constraints:
Pattern: (^true$)|(^false$)
java.lang.String pageToken
pageToken in subsequent GET requests to get
each successive page of results.
Constraints:
Pattern: ^\d{13}-\w{6}$
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobs
Job objects that are in the specified
pipeline.java.lang.String nextPageToken
NextPageToken is null.
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String status
Submitted, Progressing,
Complete, Canceled, or Error.
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
java.lang.String ascending
true. To list jobs in reverse
chronological order, enter false.
Constraints:
Pattern: (^true$)|(^false$)
java.lang.String pageToken
pageToken in subsequent GET requests to get
each successive page of results.
Constraints:
Pattern: ^\d{13}-\w{6}$
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobs
Job objects that have the specified status.java.lang.String nextPageToken
NextPageToken is null.
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String ascending
true. To list pipelines in
reverse chronological order, enter false.
Constraints:
Pattern: (^true$)|(^false$)
java.lang.String pageToken
pageToken in subsequent GET requests to get
each successive page of results.
Constraints:
Pattern: ^\d{13}-\w{6}$
com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelines
Pipeline objects.java.lang.String nextPageToken
NextPageToken is null.
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String ascending
true. To list presets in reverse
chronological order, enter false.
Constraints:
Pattern: (^true$)|(^false$)
java.lang.String pageToken
pageToken in subsequent GET requests to get
each successive page of results.
Constraints:
Pattern: ^\d{13}-\w{6}$
com.amazonaws.internal.ListWithAutoConstructFlag<T> presets
Preset objects.java.lang.String nextPageToken
NextPageToken is null.
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String progressing
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
java.lang.String completed
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
java.lang.String warning
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
java.lang.String error
Constraints:
Pattern: (^$)|(^arn:aws:sns:.*:\w{12}:.+$)
java.lang.String granteeType
Canonical: Either the canonical user ID for an AWS
account or an origin access identity for an Amazon CloudFront
distribution. Email: The
registered email address of an AWS account.Group: One of the following predefined Amazon S3
groups: AllUsers, AuthenticatedUsers, or
LogDelivery.
Constraints:
Pattern: (^Canonical$)|(^Email$)|(^Group$)
java.lang.String grantee
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> access
READ: The grantee
can read the thumbnails and metadata for thumbnails that Elastic
Transcoder adds to the Amazon S3 bucket.READ_ACP: The grantee can read the object ACL for
thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP: The grantee can write the ACL for the
thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL: The grantee has READ, READ_ACP, and
WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds
to the Amazon S3 bucket.
Constraints:
Length: 0 - 30
java.lang.String id
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String arn
java.lang.String name
Constraints: Maximum 40 characters
Constraints:
Length: 1 - 40
java.lang.String status
Active: The
pipeline is processing jobs.Paused: The
pipeline is not currently processing jobs.
Constraints:
Pattern: (^Active$)|(^Paused$)
java.lang.String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
java.lang.String outputBucket
ContentConfig and
ThumbnailConfig.
Constraints:
Pattern: ^(\w|\.|-){1,255}$
java.lang.String role
Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$
java.lang.String awsKmsKeyArn
If you use either S3 or
S3-AWS-KMS as your Encryption:Mode, you
don't need to provide a key with your job because a default key, known
as an AWS-KMS key, is created for you automatically. You need to
provide an AWS-KMS key only if you want to use a non-default AWS-KMS
key, or if you are using an Encryption:Mode of
AES-PKCS7, AES-CTR, or AES-GCM.
Constraints:
Length: 0 - 255
Notifications notifications
PipelineOutputConfig contentConfig
ContentConfig and ThumbnailConfig, or
you specify OutputBucket. Grantee object: Canonical: Either the canonical user ID for an AWS
account or an origin access identity for an Amazon CloudFront
distribution.Email: The registered email
address of an AWS account.Group: One of the
following predefined Amazon S3 groups: AllUsers,
AuthenticatedUsers, or LogDelivery.Grantee: The AWS user or group that you
want to have access to transcoded files and playlists.Access: The permission that you want to give to the
AWS user that is listed in Grantee. Valid values include:
READ: The grantee can read the objects and
metadata for objects that Elastic Transcoder adds to the Amazon S3
bucket.READ_ACP: The grantee can read the
object ACL for objects that Elastic Transcoder adds to the Amazon S3
bucket.WRITE_ACP: The grantee can write the ACL
for the objects that Elastic Transcoder adds to the Amazon S3
bucket.FULL_CONTROL: The grantee has
READ, READ_ACP, and WRITE_ACP
permissions for the objects that Elastic Transcoder adds to the Amazon
S3 bucket.PipelineOutputConfig thumbnailConfig
ContentConfig and ThumbnailConfig, or you
specify OutputBucket. Bucket: The
Amazon S3 bucket in which you want Elastic Transcoder to save
thumbnail files. Permissions: A list of the
users and/or predefined Amazon S3 groups you want to have access to
thumbnail files, and the type of access that you want them to have.
Canonical: Either the canonical user ID
for an AWS account or an origin access identity for an Amazon
CloudFront distribution. Email: The registered email address of an AWS
account.Group: One of the following predefined
Amazon S3 groups: AllUsers,
AuthenticatedUsers, or LogDelivery.Grantee: The AWS user or group that you
want to have access to thumbnail files.READ: The grantee
can read the thumbnails and metadata for thumbnails that Elastic
Transcoder adds to the Amazon S3 bucket.READ_ACP: The grantee can read the object ACL for
thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.WRITE_ACP: The grantee can write the ACL for the
thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL: The grantee has READ, READ_ACP, and
WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds
to the Amazon S3 bucket.StorageClass: The Amazon S3 storage class,
Standard or ReducedRedundancy, that you want
Elastic Transcoder to assign to the thumbnails that it stores in your
Amazon S3 bucket.java.lang.String bucket
ContentConfig
and ThumbnailConfig instead.
Constraints:
Pattern: ^(\w|\.|-){1,255}$
java.lang.String storageClass
Standard or
ReducedRedundancy, that you want Elastic Transcoder to
assign to the video files and playlists that it stores in your Amazon
S3 bucket.
Constraints:
Pattern: (^ReducedRedundancy$)|(^Standard$)
com.amazonaws.internal.ListWithAutoConstructFlag<T> permissions
Permissions object specifies which users
and/or predefined Amazon S3 groups you want to have access to
transcoded files and playlists, and the type of access you want them
to have. You can grant permissions to a maximum of 30 users and/or
predefined Amazon S3 groups. If you include
Permissions, Elastic Transcoder grants only the
permissions that you specify. It does not grant full permissions to
the owner of the role specified by Role. If you want that
user to have full control, you must explicitly grant full control to
the user.
If you omit Permissions, Elastic Transcoder
grants full control over the transcoded files and playlists to the
owner of the role specified by Role, and grants no other
permissions to any other user or group.
Constraints:
Length: 0 - 30
java.lang.String name
/ character, the section of the name before the last
/ must be identical for all Name objects. If
you create more than one master playlist, the values of all
Name objects must be unique. Note: Elastic
Transcoder automatically appends the relevant file extension to the
file name (.m3u8 for HLSv3 and
HLSv4 playlists, and .ism and
.ismc for Smooth playlists). If you include
a file extension in Name, the file name will have two
extensions.
Constraints:
Length: 1 - 255
java.lang.String format
HLSv3, HLSv4, and Smooth.
Constraints:
Pattern: (^HLSv3$)|(^HLSv4$)|(^Smooth$)
com.amazonaws.internal.ListWithAutoConstructFlag<T> outputKeys
If your
output is not HLS or does not have a segment duration
set, the name of the output file is a concatenation of
OutputKeyPrefix and Outputs:Key:
OutputKeyPrefixOutputs:Key
If your
output is HLSv3 and has a segment duration set, or is not
included in a playlist, Elastic Transcoder creates an output playlist
file with a file extension of .m3u8, and a series of
.ts files that include a five-digit sequential counter
beginning with 00000:
OutputKeyPrefixOutputs:Key.m3u8
OutputKeyPrefixOutputs:Key00000.ts
If
your output is HLSv4, has a segment duration set, and is
included in an HLSv4 playlist, Elastic Transcoder creates
an output playlist file with a file extension of
_v4.m3u8. If the output is video, Elastic Transcoder also
creates an output file with an extension of _iframe.m3u8:
OutputKeyPrefixOutputs:Key_v4.m3u8
OutputKeyPrefixOutputs:Key_iframe.m3u8
OutputKeyPrefixOutputs:Key.ts
Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.
If you include more than one output
in a playlist, any segment duration settings, clip settings, or
caption settings must be the same for all outputs in the playlist. For
Smooth playlists, the Audio:Profile,
Video:Profile, and Video:FrameRate to
Video:KeyframesMaxDist ratio must be the same for all
outputs.
Constraints:
Length: 0 - 30
HlsContentProtection hlsContentProtection
java.lang.String status
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
java.lang.String statusDetail
Constraints:
Length: 0 - 255
java.lang.String id
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String arn
java.lang.String name
Constraints:
Length: 1 - 40
java.lang.String description
Constraints:
Length: 0 - 255
java.lang.String container
fmp4, mp3, mp4,
ogg, ts, and webm.
Constraints:
Pattern: (^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)|(^fmp4$)
AudioParameters audio
VideoParameters video
Thumbnails thumbnails
java.lang.String type
System) or a preset that you have defined
(Custom).
Constraints:
Pattern: (^System$)|(^Custom$)
java.lang.String id
Id can be up to 40 characters long.
Constraints:
Length: 1 - 40
java.lang.String maxWidth
MaxWidth.Target to specify whether you want Elastic
Transcoder to include the black bars that are added by Elastic
Transcoder, if any, in the calculation.MaxWidth.
Constraints:
Pattern: (^\d{1,3}(\.\d{0,5})?%$)|(^\d{1,4}?px$)
java.lang.String maxHeight
MaxHeight.Target to specify whether you want Elastic
Transcoder to include the black bars that are added by Elastic
Transcoder, if any, in the calculation.MaxHeight.
Constraints:
Pattern: (^\d{1,3}(\.\d{0,5})?%$)|(^\d{1,4}?px$)
java.lang.String sizingPolicy
MaxWidth or
MaxHeight without exceeding the other value.MaxWidth and
MaxHeight. If the relative proportions of the watermark
and the values of MaxWidth and MaxHeight are
different, the watermark will be distorted.MaxWidth and MaxHeight without
exceeding either value. If you specify this option, Elastic Transcoder
does not scale the watermark up.
Constraints:
Pattern: (^Fit$)|(^Stretch$)|(^ShrinkToFit$)
java.lang.String horizontalAlign
HorizontalOffset:
Constraints:
Pattern: (^Left$)|(^Right$)|(^Center$)
java.lang.String horizontalOffset
HorizontalAlign and 5px for
HorizontalOffset, the left side of the watermark appears
5 pixels from the left border of the output video.
HorizontalOffset is only valid when the value of
HorizontalAlign is Left or
Right. If you specify an offset that causes the watermark
to extend beyond the left or right border and Elastic Transcoder has
not added black bars, the watermark is cropped. If Elastic Transcoder
has added black bars, the watermark extends into the black bars. If
the watermark extends beyond the black bars, it is cropped.
Use the
value of Target to specify whether you want to include
the black bars that are added by Elastic Transcoder, if any, in the
offset calculation.
Constraints:
Pattern: (^\d{1,3}(\.\d{0,5})?%$)|(^\d{1,4}?px$)
java.lang.String verticalAlign
VerticalOffset:
Constraints:
Pattern: (^Top$)|(^Bottom$)|(^Center$)
java.lang.String verticalOffset
VerticalOffset The amount by which you want the vertical position of the watermark to be offset from the position specified by VerticalAlign:
MaxHeight.Top for VerticalAlign and 5px
for VerticalOffset, the top of the watermark appears 5
pixels from the top border of the output video.
VerticalOffset is only valid when the value of
VerticalAlign is Top or Bottom.
If you specify an offset that causes the watermark to extend beyond the top or bottom border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped.
Use the value of Target to specify whether
you want Elastic Transcoder to include the black bars that are added
by Elastic Transcoder, if any, in the offset calculation.
Constraints:
Pattern: (^\d{1,3}(\.\d{0,5})?%$)|(^\d{1,4}?px$)
java.lang.String opacity
Opacity
is float. Elastic Transcoder supports transparent .png graphics. If
you use a transparent .png, the transparent portion of the video
appears as if you had specified a value of 0 for Opacity.
The .jpg file format doesn't support transparency.
Constraints:
Pattern: ^\d{1,3}(\.\d{0,20})?$
java.lang.String target
HorizontalOffset,
VerticalOffset, MaxWidth, and
MaxHeight: HorizontalOffset and VerticalOffset values
are calculated based on the borders of the video excluding black bars
added by Elastic Transcoder, if any. In addition,
MaxWidth and MaxHeight, if specified as a
percentage, are calculated based on the borders of the video excluding
black bars added by Elastic Transcoder, if any.HorizontalOffset and VerticalOffset values
are calculated based on the borders of the video including black bars
added by Elastic Transcoder, if any.MaxWidth and MaxHeight, if specified as a
percentage, are calculated based on the borders of the video including
black bars added by Elastic Transcoder, if any.
Constraints:
Pattern: (^Content$)|(^Frame$)
Job job
Pipeline pipeline
Preset preset
java.lang.String role
Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$
java.lang.String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
java.lang.String outputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
com.amazonaws.internal.ListWithAutoConstructFlag<T> topics
Constraints:
Length: 0 - 30
java.lang.String success
true;
otherwise, the value is false.
Constraints:
Pattern: (^true$)|(^false$)
com.amazonaws.internal.ListWithAutoConstructFlag<T> messages
Success element contains false, this
value is an array of one or more error messages that were generated
during the test process.java.lang.String format
jpg
and png. You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
Constraints:
Pattern: (^jpg$)|(^png$)
java.lang.String interval
Constraints:
Pattern: ^\d{1,5}$
java.lang.String resolution
To better control resolution and aspect ratio of
thumbnails, we recommend that you use the values
MaxWidth, MaxHeight,
SizingPolicy, and PaddingPolicy instead of
Resolution and AspectRatio. The two groups
of settings are mutually exclusive. Do not use them together.
The width and height of thumbnail files in pixels.
Specify a value in the format width x
height where both values are even integers. The
values cannot exceed the width and height that you specified in the
Video:Resolution object.
Constraints:
Pattern: ^\d{1,5}x\d{1,5}$
java.lang.String aspectRatio
To better control resolution and aspect ratio of
thumbnails, we recommend that you use the values
MaxWidth, MaxHeight,
SizingPolicy, and PaddingPolicy instead of
Resolution and AspectRatio. The two groups
of settings are mutually exclusive. Do not use them together.
The aspect ratio of thumbnails. Valid values include:
auto, 1:1, 4:3,
3:2, 16:9
If you specify
auto, Elastic Transcoder tries to preserve the aspect
ratio of the video in the output file.
Constraints:
Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)
java.lang.String maxWidth
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
java.lang.String maxHeight
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
java.lang.String sizingPolicy
Fit: Elastic Transcoder scales thumbnails so
they match the value that you specified in thumbnail MaxWidth or
MaxHeight settings without exceeding the other value. Fill: Elastic Transcoder scales thumbnails so they
match the value that you specified in thumbnail MaxWidth
or MaxHeight settings and matches or exceeds the other
value. Elastic Transcoder centers the image in thumbnails and then
crops in the dimension (if any) that exceeds the maximum value.Stretch: Elastic Transcoder stretches thumbnails to
match the values that you specified for thumbnail
MaxWidth and MaxHeight settings. If the
relative proportions of the input video and thumbnails are different,
the thumbnails will be distorted.Keep: Elastic
Transcoder does not scale thumbnails. If either dimension of the input
video exceeds the values that you specified for thumbnail
MaxWidth and MaxHeight settings, Elastic
Transcoder crops the thumbnails.ShrinkToFit:
Elastic Transcoder scales thumbnails down so that their dimensions
match the values that you specified for at least one of thumbnail
MaxWidth and MaxHeight without exceeding
either value. If you specify this option, Elastic Transcoder does not
scale thumbnails up.ShrinkToFill: Elastic
Transcoder scales thumbnails down so that their dimensions match the
values that you specified for at least one of MaxWidth
and MaxHeight without dropping below either value. If you
specify this option, Elastic Transcoder does not scale thumbnails
up.
Constraints:
Pattern: (^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)
java.lang.String paddingPolicy
PaddingPolicy to Pad, Elastic
Transcoder may add black bars to the top and bottom and/or left and
right sides of thumbnails to make the total size of the thumbnails
match the values that you specified for thumbnail
MaxWidth and MaxHeight settings.
Constraints:
Pattern: (^Pad$)|(^NoPad$)
java.lang.String startTime
Constraints:
Pattern: (^\d{1,5}(\.\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\.\d{0,3})?$)
java.lang.String duration
If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes the file and returns a warning message.
Constraints:
Pattern: (^\d{1,5}(\.\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\.\d{0,3})?$)
java.lang.String id
Constraints:
Pattern: ^\d{13}-\w{6}$
Notifications notifications
Pipeline pipeline
java.lang.String id
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String name
Constraints: Maximum 40 characters
Constraints:
Length: 1 - 40
java.lang.String inputBucket
Constraints:
Pattern: ^(\w|\.|-){1,255}$
java.lang.String role
Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$
java.lang.String awsKmsKeyArn
If you use either S3 or
S3-AWS-KMS as your Encryption:Mode, you
don't need to provide a key with your job because a default key, known
as an AWS-KMS key, is created for you automatically. You need to
provide an AWS-KMS key only if you want to use a non-default AWS-KMS
key, or if you are using an Encryption:Mode of
AES-PKCS7, AES-CTR, or AES-GCM.
Constraints:
Length: 0 - 255
Notifications notifications
PipelineOutputConfig contentConfig
ContentConfig object specifies information
about the Amazon S3 bucket in which you want Elastic Transcoder to
save transcoded files and playlists: which bucket to use, which users
you want to have access to the files, the type of access you want
users to have, and the storage class that you want to assign to the
files. If you specify values for ContentConfig, you
must also specify values for ThumbnailConfig.
If you
specify values for ContentConfig and
ThumbnailConfig, omit the OutputBucket
object.
Grantee object: Grantee object is either the canonical user ID for an
AWS account or an origin access identity for an Amazon CloudFront
distribution. For more information about canonical user IDs, see
Access Control List (ACL) Overview in the Amazon Simple Storage
Service Developer Guide. For more information about using CloudFront
origin access identities to require that users use CloudFront URLs
instead of Amazon S3 URLs, see Using an Origin Access Identity to
Restrict Access to Your Amazon S3 Content. Grantee object is the
registered email address of an AWS account.Grantee object is one of the following
predefined Amazon S3 groups: AllUsers,
AuthenticatedUsers, or LogDelivery.Grantee. Permissions are
granted on the files that Elastic Transcoder adds to the bucket,
including playlists and video files. Valid values include: READ: The grantee can read the objects and metadata
for objects that Elastic Transcoder adds to the Amazon S3 bucket.READ_ACP: The grantee can read the object ACL for
objects that Elastic Transcoder adds to the Amazon S3 bucket. WRITE_ACP: The grantee can write the ACL for the
objects that Elastic Transcoder adds to the Amazon S3 bucket.FULL_CONTROL: The grantee has READ,
READ_ACP, and WRITE_ACP permissions for the
objects that Elastic Transcoder adds to the Amazon S3 bucket.Standard or ReducedRedundancy, that you want
Elastic Transcoder to assign to the video files and playlists that it
stores in your Amazon S3 bucket.PipelineOutputConfig thumbnailConfig
ThumbnailConfig object specifies several values,
including the Amazon S3 bucket in which you want Elastic Transcoder to
save thumbnail files, which users you want to have access to the
files, the type of access you want users to have, and the storage
class that you want to assign to the files. If you specify values
for ContentConfig, you must also specify values for
ThumbnailConfig even if you don't want to create
thumbnails.
If you specify values for ContentConfig
and ThumbnailConfig, omit the OutputBucket
object.
Permissions object
specifies which users and/or predefined Amazon S3 groups you want to
have access to thumbnail files, and the type of access you want them
to have. You can grant permissions to a maximum of 30 users and/or
predefined Amazon S3 groups.Grantee object is
either the canonical user ID for an AWS account or an origin access
identity for an Amazon CloudFront distribution. Grantee object is the
registered email address of an AWS account. Grantee object is one of the following
predefined Amazon S3 groups: AllUsers,
AuthenticatedUsers, or LogDelivery.Grantee. Permissions are granted on
the thumbnail files that Elastic Transcoder adds to the bucket. Valid
values include: READ: The grantee can read the
thumbnails and metadata for objects that Elastic Transcoder adds to
the Amazon S3 bucket.READ_ACP: The grantee can
read the object ACL for thumbnails that Elastic Transcoder adds to the
Amazon S3 bucket. WRITE_ACP: The grantee can
write the ACL for the thumbnails that Elastic Transcoder adds to the
Amazon S3 bucket.FULL_CONTROL: The grantee has
READ, READ_ACP, and WRITE_ACP
permissions for the thumbnails that Elastic Transcoder adds to the
Amazon S3 bucket. Standard or
ReducedRedundancy, that you want Elastic Transcoder to
assign to the thumbnails that it stores in your Amazon S3 bucket.Pipeline pipeline
java.lang.String id
Constraints:
Pattern: ^\d{13}-\w{6}$
java.lang.String status
Active: The
pipeline is processing jobs.Paused: The
pipeline is not currently processing jobs.
Constraints:
Pattern: (^Active$)|(^Paused$)
Pipeline pipeline
java.lang.String codec
H.264 and vp8. You can only specify
vp8 when the container type is webm.
Constraints:
Pattern: (^H\.264$)|(^vp8$)
java.util.Map<K,V> codecOptions
The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles:
baseline: The profile most commonly used for
videoconferencing and for mobile applications.main: The profile used for standard-definition
digital TV broadcasts.high: The profile used
for high-definition digital TV broadcasts and for Blu-ray discs.Level (H.264 Only)
The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels:
1, 1b, 1.1,
1.2, 1.3, 2, 2.1,
2.2, 3, 3.1, 3.2,
4, 4.1
MaxReferenceFrames (H.264 Only)
Applicable only when the value of Video:Codec is H.264. The maximum number of previously decoded frames to use as a reference for decoding future frames. Valid values are integers 0 through 16, but we recommend that you not use a value greater than the following:
Min(Floor(Maximum decoded picture buffer in macroblocks *
256 / (Width in pixels * Height in pixels)), 16)
where
Width in pixels and Height in pixels represent either
MaxWidth and MaxHeight, or Resolution. Maximum decoded picture
buffer in macroblocks depends on the value of the
Level object. See the list below. (A macroblock is a
block of pixels measuring 16x16.)
MaxBitRate
The maximum number
of bits per second in a video buffer; the size of the buffer is
specified by BufferSize. Specify a value between 16 and
62,500. You can reduce the bandwidth required to stream a video by
reducing the maximum bit rate, but this also reduces the quality of
the video.
BufferSize
The maximum number of bits in any
x seconds of the output video. This window is commonly 10 seconds, the
standard segment duration when you're using FMP4 or MPEG-TS for the
container type of the output video. Specify an integer greater than 0.
If you specify MaxBitRate and omit
BufferSize, Elastic Transcoder sets
BufferSize to 10 times the value of
MaxBitRate.
Constraints:
Length: 0 - 30
java.lang.String keyframesMaxDist
For
Smooth outputs, the FrameRate must have a
constant ratio to the KeyframesMaxDist. This allows
Smooth playlists to switch between different quality
levels while the file is being played.
For example, an input file
can have a FrameRate of 30 with a
KeyframesMaxDist of 90. The output file then needs to
have a ratio of 1:3. Valid outputs would have FrameRate
of 30, 25, and 10, and KeyframesMaxDist of 90, 75, and
30, respectively.
Alternately, this can be achieved by setting
FrameRate to auto and having the same values for
MaxFrameRate and KeyframesMaxDist.
Constraints:
Pattern: ^\d{1,6}$
java.lang.String fixedGOP
FixedGOP. Valid values
are true and false: true: Elastic Transcoder uses the value of
KeyframesMaxDist for the distance between key frames (the
number of frames in a group of pictures, or GOP).false: The distance between key frames can vary.FixedGOP must be set to
true for fmp4 containers.
Constraints:
Pattern: (^true$)|(^false$)
java.lang.String bitRate
Level and Profile. If you specify
auto, Elastic Transcoder uses the detected bit rate of
the input source. If you specify a value other than auto,
we recommend that you specify a value less than or equal to the
maximum H.264-compliant value listed for your level and profile: Level - Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum video bit rate in kilobits/second (high Profile)
Constraints:
Pattern: (^\d{2,5}$)|(^auto$)
java.lang.String frameRate
auto, 10,
15, 23.97, 24, 25,
29.97, 30, 60
If you specify
auto, Elastic Transcoder uses the detected frame rate of
the input source. If you specify a frame rate, we recommend that you
perform the following calculation:
Frame rate = maximum
recommended decoding speed in luma samples/second / (width in pixels *
height in pixels)
where:
The maximum recommended decoding speed in Luma samples/second for each level is described in the following list (Level - Decoding speed):
Constraints:
Pattern: (^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)
java.lang.String maxFrameRate
auto for FrameRate, Elastic
Transcoder uses the frame rate of the input video for the frame rate
of the output video. Specify the maximum frame rate that you want
Elastic Transcoder to use when the frame rate of the input video is
greater than the desired maximum frame rate of the output video. Valid
values include: 10, 15, 23.97,
24, 25, 29.97, 30,
60.
Constraints:
Pattern: (^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)
java.lang.String resolution
To better control resolution and aspect ratio of output
videos, we recommend that you use the values MaxWidth,
MaxHeight, SizingPolicy,
PaddingPolicy, and DisplayAspectRatio
instead of Resolution and AspectRatio. The
two groups of settings are mutually exclusive. Do not use them
together.
The width and height of the video in the
output file, in pixels. Valid values are auto and
width x height:
auto: Elastic
Transcoder attempts to preserve the width and height of the input
file, subject to the following rules.width x
height: The width and height of the output video in
pixels.Note the following about specifying the width and height:
Constraints:
Pattern: (^auto$)|(^\d{1,5}x\d{1,5}$)
java.lang.String aspectRatio
To better control resolution and aspect ratio of output
videos, we recommend that you use the values MaxWidth,
MaxHeight, SizingPolicy,
PaddingPolicy, and DisplayAspectRatio
instead of Resolution and AspectRatio. The
two groups of settings are mutually exclusive. Do not use them
together.
The display aspect ratio of the video in the output file. Valid values include:
auto,
1:1, 4:3, 3:2,
16:9
If you specify auto, Elastic
Transcoder tries to preserve the aspect ratio of the input file.
If you specify an aspect ratio for the output file that differs from aspect ratio of the input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars on the top and bottom) to maintain the aspect ratio of the active region of the video.
Constraints:
Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)
java.lang.String maxWidth
auto, Elastic Transcoder uses 1920 (Full HD) as the
default value. If you specify a numeric value, enter an even integer
between 128 and 4096.
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
java.lang.String maxHeight
auto, Elastic Transcoder uses 1080 (Full HD) as the
default value. If you specify a numeric value, enter an even integer
between 96 and 3072.
Constraints:
Pattern: (^auto$)|(^\d{2,4}$)
java.lang.String displayAspectRatio
Constraints:
Pattern: (^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)
java.lang.String sizingPolicy
Fit: Elastic Transcoder scales the
output video so it matches the value that you specified in either
MaxWidth or MaxHeight without exceeding the
other value.Fill: Elastic Transcoder scales the
output video so it matches the value that you specified in either
MaxWidth or MaxHeight and matches or exceeds
the other value. Elastic Transcoder centers the output video and then
crops it in the dimension (if any) that exceeds the maximum
value.Stretch: Elastic Transcoder stretches the
output video to match the values that you specified for
MaxWidth and MaxHeight. If the relative
proportions of the input video and the output video are different, the
output video will be distorted.Keep: Elastic
Transcoder does not scale the output video. If either dimension of the
input video exceeds the values that you specified for
MaxWidth and MaxHeight, Elastic Transcoder
crops the output video.ShrinkToFit: Elastic
Transcoder scales the output video down so that its dimensions match
the values that you specified for at least one of
MaxWidth and MaxHeight without exceeding
either value. If you specify this option, Elastic Transcoder does not
scale the video up.ShrinkToFill: Elastic
Transcoder scales the output video down so that its dimensions match
the values that you specified for at least one of
MaxWidth and MaxHeight without dropping
below either value. If you specify this option, Elastic Transcoder
does not scale the video up.
Constraints:
Pattern: (^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)
java.lang.String paddingPolicy
PaddingPolicy to Pad, Elastic
Transcoder may add black bars to the top and bottom and/or left and
right sides of the output video to make the total size of the output
video match the values that you specified for MaxWidth
and MaxHeight.
Constraints:
Pattern: (^Pad$)|(^NoPad$)
com.amazonaws.internal.ListWithAutoConstructFlag<T> watermarks
Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.
When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions.
java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.java.lang.String vaultName
java.lang.String uploadId
java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.java.lang.String vaultName
java.lang.String uploadId
java.lang.String archiveSize
java.lang.String checksum
java.lang.String location
java.lang.String checksum
java.lang.String archiveId
java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.java.lang.String vaultName
java.lang.String strategy
Valid values: BytesPerHour|FreeTier|None
java.lang.Long bytesPerHour
This
field is required only if the value of the Strategy field is
BytesPerHour. Your PUT operation will be rejected if the
Strategy field is not set to BytesPerHour and you set
this field.
java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.java.lang.String vaultName
java.lang.String archiveId
java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.java.lang.String vaultName
java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.java.lang.String vaultName
java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.java.lang.String vaultName
java.lang.String jobId
java.lang.String jobId
java.lang.String jobDescription
java.lang.String action
Constraints:
Allowed Values: ArchiveRetrieval, InventoryRetrieval
java.lang.String archiveId
java.lang.String vaultARN
java.lang.String creationDate
java.lang.Boolean completed
java.lang.String statusCode
Constraints:
Allowed Values: InProgress, Succeeded, Failed
java.lang.String statusMessage
java.lang.Long archiveSizeInBytes
java.lang.Long inventorySizeInBytes
java.lang.String sNSTopic
java.lang.String completionDate
java.lang.String sHA256TreeHash
The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.
For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.
This field is null in the following situations:
Archive retrieval jobs that specify a range that is not tree-hash aligned.
Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.
Inventory jobs.
java.lang.String archiveSHA256TreeHash
java.lang.String retrievalByteRange
InventoryRetrievalJobDescription inventoryRetrievalParameters
java.lang.String vaultARN
java.lang.String vaultName
java.lang.String creationDate
java.lang.String lastInventoryDate
java.lang.Long numberOfArchives
null if an inventory has not yet
run on the vault, for example, if you just created the vault.java.lang.Long sizeInBytes
java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.java.lang.String vaultName
java.lang.String vaultARN
java.lang.String vaultName
java.lang.String creationDate
java.lang.String lastInventoryDate
java.lang.Long numberOfArchives
null if an inventory has not yet
run on the vault, for example, if you just created the vault.java.lang.Long sizeInBytes
java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
the dashes hyphens in it.DataRetrievalPolicy policy
java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.java.lang.String vaultName
java.lang.String jobId
java.lang.String range
java.io.InputStream body
java.lang.String checksum
java.lang.Integer status
java.lang.String contentRange
java.lang.String acceptRanges
java.lang.String contentType
java.lang.String archiveDescription
java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.java.lang.String vaultName
VaultNotificationConfig vaultNotificationConfig
java.lang.String jobId
java.lang.String jobDescription
java.lang.String action
Constraints:
Allowed Values: ArchiveRetrieval, InventoryRetrieval
java.lang.String archiveId
java.lang.String vaultARN
java.lang.String creationDate
java.lang.Boolean completed
java.lang.String statusCode
Constraints:
Allowed Values: InProgress, Succeeded, Failed
java.lang.String statusMessage
java.lang.Long archiveSizeInBytes
java.lang.Long inventorySizeInBytes
java.lang.String sNSTopic
java.lang.String completionDate
java.lang.String sHA256TreeHash
The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.
For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.
This field is null in the following situations:
Archive retrieval jobs that specify a range that is not tree-hash aligned.
Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.
Inventory jobs.
java.lang.String archiveSHA256TreeHash
java.lang.String retrievalByteRange
InventoryRetrievalJobDescription inventoryRetrievalParameters
java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.java.lang.String vaultName
JobParameters jobParameters
java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.java.lang.String vaultName
java.lang.String archiveDescription
The part size must be a megabyte (1024 KB) multiplied by a power of 2???for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).
java.lang.String partSize
java.lang.String format
java.lang.String startDate
java.lang.String endDate
java.lang.String limit
java.lang.String marker
null.
For more information, see
Range Inventory Retrieval.java.lang.String startDate
java.lang.String endDate
java.lang.String limit
java.lang.String marker
null.java.lang.String format
java.lang.String type
java.lang.String archiveId
Type is set to archive-retrieval. An
error occurs if you specify this request parameter for an inventory
retrieval job request.java.lang.String description
java.lang.String sNSTopic
java.lang.String retrievalByteRange
An error occurs if you specify this field for an inventory retrieval job request.
InventoryRetrievalJobInput inventoryRetrievalParameters
java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.java.lang.String vaultName
java.lang.String limit
java.lang.String marker
java.lang.String statuscode
java.lang.String completed
true or false.com.amazonaws.internal.ListWithAutoConstructFlag<T> jobList
java.lang.String marker
null.java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.java.lang.String vaultName
java.lang.String uploadIdMarker
java.lang.String limit
com.amazonaws.internal.ListWithAutoConstructFlag<T> uploadsList
java.lang.String marker
null.java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.java.lang.String vaultName
java.lang.String uploadId
java.lang.String marker
java.lang.String limit
java.lang.String multipartUploadId
java.lang.String vaultARN
java.lang.String archiveDescription
java.lang.Long partSizeInBytes
java.lang.String creationDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> parts
java.lang.String marker
null.java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.java.lang.String marker
java.lang.String limit
java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
the dashes in it.DataRetrievalPolicy policy
java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.java.lang.String vaultName
VaultNotificationConfig vaultNotificationConfig
java.lang.Long contentLength
java.lang.String vaultName
java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.java.lang.String archiveDescription
java.lang.String checksum
java.io.InputStream body
java.lang.String location
java.lang.String checksum
java.lang.String archiveId
java.lang.String multipartUploadId
java.lang.String vaultARN
java.lang.String archiveDescription
java.lang.Long partSizeInBytes
java.lang.String creationDate
java.lang.String accountId
AccountId is the AWS Account ID. You can specify
either the AWS Account ID or optionally a '-', in which case Amazon
Glacier uses the AWS Account ID associated with the credentials used
to sign the request. If you specify your Account ID, do not include
hyphens in it.java.lang.String vaultName
java.lang.String uploadId
java.lang.String checksum
java.lang.String range
java.io.InputStream body
java.lang.String sNSTopic
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
java.lang.String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String status
Active means the key is
valid for API calls, while Inactive means it is not.
Constraints:
Allowed Values: Active, Inactive
java.lang.String secretAccessKey
java.util.Date createDate
java.lang.String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String status
Active means the key is
valid for API calls; Inactive means it is not.
Constraints:
Allowed Values: Active, Inactive
java.util.Date createDate
java.lang.String openIDConnectProviderArn
Constraints:
Length: 20 - 2048
java.lang.String clientID
Constraints:
Length: 1 - 255
java.lang.String oldPassword
Constraints:
Length: 1 - 128
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.String newPassword
Constraints:
Length: 1 - 128
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
AccessKey accessKey
java.lang.String path
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
java.lang.String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
Group group
java.lang.String instanceProfileName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String path
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
InstanceProfile instanceProfile
java.lang.String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String password
Constraints:
Length: 1 - 128
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.Boolean passwordResetRequired
LoginProfile loginProfile
java.lang.String url
iss claim in the provider's
OpenID Connect ID tokens. Per the OIDC standard, path components are
allowed but query parameters are not. Typically the URL consists of
only a host name, like "https://server.example.org" or
"https://example.com". You cannot register the same provider multiple times in a single AWS account. If you try to submit a URL that has already been used for an OpenID Connect provider in the AWS account, you will get an error.
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> clientIDList
client_id parameter on OAuth requests.) You can register multiple client IDs with the same provider. For example, you might have multiple applications that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider.
There is no defined format for a client ID. The
CreateOpenIDConnectProviderRequest action accepts client
IDs up to 255 characters long.
com.amazonaws.internal.ListWithAutoConstructFlag<T> thumbprintList
The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.
You must provide at least one thumbprint when creating an IAM OIDC
provider. For example, if the OIDC provider is
server.example.com and the provider stores its keys at
"https://keys.server.example.com/openid-connect", the thumbprint
string would be the hex-encoded SHA-1 hash value of the certificate
used by https://keys.server.example.com.
java.lang.String openIDConnectProviderArn
Constraints:
Length: 20 - 2048
java.lang.String path
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
java.lang.String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String assumeRolePolicyDocument
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
Role role
java.lang.String sAMLMetadataDocument
For more information, see Creating Temporary Security Credentials for SAML Federation in the Using Temporary Security Credentials guide.
Constraints:
Length: 1000 - 10000000
java.lang.String name
Constraints:
Length: 1 - 128
Pattern: [\w._-]*
java.lang.String path
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
java.lang.String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
User user
java.lang.String path
This parameter is optional. If it is not included, it defaults to a slash (/).
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
java.lang.String virtualMFADeviceName
Constraints:
Length: 1 -
Pattern: [\w+=,.@-]*
VirtualMFADevice virtualMFADevice
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String serialNumber
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String openIDConnectProviderArn
Constraints:
Length: 20 - 2048
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String serialNumber
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
java.lang.String authenticationCode1
Constraints:
Length: 6 - 6
Pattern: [\d]*
java.lang.String authenticationCode2
Constraints:
Length: 6 - 6
Pattern: [\d]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> filter
java.lang.Integer maxItems
IsTruncated response
element is true. This parameter is optional. If you do
not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> userDetailList
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupDetailList
com.amazonaws.internal.ListWithAutoConstructFlag<T> roleDetailList
java.lang.Boolean isTruncated
Marker request parameter to retrieve more
items.java.lang.String marker
IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
PasswordPolicy passwordPolicy
This data type is used as a response element in the GetAccountPasswordPolicy action.
java.util.Map<K,V> summaryMap
SummaryMap contains the following keys:
AccessKeysPerUserQuota - Maximum number of access
keys that can be created per user
AccountMFAEnabled - 1 if the root account has an
MFA device assigned to it, 0 otherwise
AssumeRolePolicySizeQuota - Maximum allowed size
for assume role policy documents (in kilobytes)
GroupPolicySizeQuota - Maximum allowed size for
Group policy documents (in kilobytes)
Groups
- Number of Groups for the AWS account
GroupsPerUserQuota - Maximum number of groups an
IAM user can belong to
GroupsQuota - Maximum
groups allowed for the AWS account
InstanceProfiles - Number of instance profiles for
the AWS account
InstanceProfilesQuota -
Maximum instance profiles allowed for the AWS account
MFADevices - Number of MFA devices, either
assigned or unassigned
MFADevicesInUse -
Number of MFA devices that have been assigned to an IAM user or to the
root account
RolePolicySizeQuota - Maximum
allowed size for role policy documents (in kilobytes)
Roles - Number of roles for the AWS account
RolesQuota - Maximum roles allowed for the AWS
account
ServerCertificates - Number of server
certificates for the AWS account
ServerCertificatesQuota - Maximum server
certificates allowed for the AWS account
SigningCertificatesPerUserQuota - Maximum number
of X509 certificates allowed for a user
UserPolicySizeQuota - Maximum allowed size for
user policy documents (in kilobytes)
Users -
Number of users for the AWS account
UsersQuota - Maximum users allowed for the AWS
account
java.nio.ByteBuffer content
java.lang.String reportFormat
Constraints:
Allowed Values: text/csv
java.util.Date generatedTime
java.lang.String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Integer maxItems
IsTruncated response
element is true. This parameter is optional. If you do
not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
Group group
com.amazonaws.internal.ListWithAutoConstructFlag<T> users
java.lang.Boolean isTruncated
Marker request parameter to retrieve
more user names in the list.java.lang.String marker
true, then this element is present and
contains the value to use for the Marker parameter in a
subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
InstanceProfile instanceProfile
LoginProfile loginProfile
java.lang.String openIDConnectProviderArn
Constraints:
Length: 20 - 2048
java.lang.String url
Constraints:
Length: 1 - 255
com.amazonaws.internal.ListWithAutoConstructFlag<T> clientIDList
com.amazonaws.internal.ListWithAutoConstructFlag<T> thumbprintList
java.util.Date createDate
java.lang.String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
Role role
java.lang.String sAMLMetadataDocument
Constraints:
Length: 1000 - 10000000
java.util.Date createDate
java.util.Date validUntil
ServerCertificate serverCertificate
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
User user
java.lang.String path
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
java.lang.String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String groupId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String arn
Constraints:
Length: 20 - 2048
java.util.Date createDate
java.lang.String path
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
java.lang.String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String groupId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String arn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
java.util.Date createDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupPolicyList
java.lang.String path
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
java.lang.String instanceProfileName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String instanceProfileId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String arn
Constraints:
Length: 20 - 2048
java.util.Date createDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> roles
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String marker
Marker element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Integer maxItems
IsTruncated response element is true. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> accessKeyMetadata
java.lang.Boolean isTruncated
Marker request parameter to retrieve more keys
in the list.java.lang.String marker
IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Integer maxItems
IsTruncated response element is true. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> accountAliases
java.lang.Boolean isTruncated
Marker request parameter to retrieve
more account aliases in the list.java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Integer maxItems
IsTruncated response element is true. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
java.lang.Boolean isTruncated
Marker request parameter to retrieve
more policy names in the list.java.lang.String marker
IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Integer maxItems
IsTruncated response
element is true. This parameter is optional. If you do
not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
java.lang.Boolean isTruncated
Marker request parameter to retrieve more
groups in the list.java.lang.String marker
IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.String pathPrefix
/division_abc/subdivision_xyz/ gets all groups whose path
starts with /division_abc/subdivision_xyz/. This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups.
Constraints:
Length: 1 - 512
Pattern: \u002F[\u0021-\u007F]*
java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Integer maxItems
IsTruncated response
element is true. This parameter is optional. If you do
not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> groups
java.lang.Boolean isTruncated
Marker request parameter to retrieve more
groups in the list.java.lang.String marker
IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String marker
Marker element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Integer maxItems
IsTruncated response element is true. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceProfiles
java.lang.Boolean isTruncated
Marker request parameter to
retrieve more instance profiles in the list.java.lang.String marker
IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.String pathPrefix
/application_abc/component_xyz/ gets all instance
profiles whose path starts with
/application_abc/component_xyz/. This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles.
Constraints:
Length: 1 - 512
Pattern: \u002F[\u0021-\u007F]*
java.lang.String marker
Marker element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Integer maxItems
IsTruncated response element is true. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceProfiles
java.lang.Boolean isTruncated
Marker request parameter to
retrieve more instance profiles in the list.java.lang.String marker
IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Integer maxItems
IsTruncated
response element is true. This parameter is optional. If
you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> mFADevices
java.lang.Boolean isTruncated
Marker request parameter to retrieve
more MFA devices in the list.java.lang.String marker
IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String marker
Marker element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Integer maxItems
IsTruncated response element is true. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
java.lang.Boolean isTruncated
Marker request parameter to retrieve
more policy names in the list.java.lang.String marker
IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.String pathPrefix
/application_abc/component_xyz/ gets all roles whose path
starts with /application_abc/component_xyz/. This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles.
Constraints:
Length: 1 - 512
Pattern: \u002F[\u0021-\u007F]*
java.lang.String marker
Marker element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Integer maxItems
IsTruncated response element is true. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> roles
java.lang.Boolean isTruncated
Marker request parameter to retrieve more roles
in the list.java.lang.String marker
IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.String pathPrefix
/company/servercerts would get all server certificates
for which the path starts with /company/servercerts. This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates.
Constraints:
Length: 1 - 512
Pattern: \u002F[\u0021-\u007F]*
java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Integer maxItems
IsTruncated response element will be set to
true. This parameter is optional. If you do not include
it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> serverCertificateMetadataList
java.lang.Boolean isTruncated
Marker request parameter to
retrieve more server certificates in the list.java.lang.String marker
IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Integer maxItems
IsTruncated response element is true. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> certificates
java.lang.Boolean isTruncated
Marker request parameter to retrieve
more certificates in the list.java.lang.String marker
IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String marker
Marker element in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Integer maxItems
IsTruncated response element is true. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
java.lang.Boolean isTruncated
Marker request parameter to retrieve
more policy names in the list.java.lang.String marker
IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.String pathPrefix
/division_abc/subdivision_xyz/, which would get all user
names whose path starts with
/division_abc/subdivision_xyz/. This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names.
Constraints:
Length: 1 - 512
Pattern: \u002F[\u0021-\u007F]*
java.lang.String marker
Marker element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Integer maxItems
IsTruncated response element is true. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> users
java.lang.Boolean isTruncated
Marker request parameter to retrieve
more users in the list.java.lang.String marker
IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.String assignmentStatus
AssignmentStatus, the action defaults to
Any which lists both assigned and unassigned virtual MFA
devices.
Constraints:
Allowed Values: Assigned, Unassigned, Any
java.lang.String marker
Marker element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Integer maxItems
IsTruncated response element is true. This
parameter is optional. If you do not include it, it defaults to 100.
Constraints:
Range: 1 - 1000
com.amazonaws.internal.ListWithAutoConstructFlag<T> virtualMFADevices
AssignmentStatus value that was passed in the request.java.lang.Boolean isTruncated
Marker request parameter to retrieve more items
the list.java.lang.String marker
IsTruncated is true, this element is
present and contains the value to use for the Marker
parameter in a subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.util.Date createDate
java.lang.Boolean passwordResetRequired
java.lang.String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String serialNumber
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
java.util.Date enableDate
java.lang.String arn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
java.lang.Integer minimumPasswordLength
Constraints:
Range: 6 - 128
java.lang.Boolean requireSymbols
java.lang.Boolean requireNumbers
java.lang.Boolean requireUppercaseCharacters
java.lang.Boolean requireLowercaseCharacters
java.lang.Boolean allowUsersToChangePassword
java.lang.Boolean expirePasswords
java.lang.Integer maxPasswordAge
Constraints:
Range: 1 - 1095
java.lang.Integer passwordReusePrevention
Constraints:
Range: 1 - 24
java.lang.Boolean hardExpiry
java.lang.String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyDocument
The returned policy is URL-encoded according to RFC 3986.
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.String openIDConnectProviderArn
Constraints:
Length: 20 - 2048
java.lang.String clientID
Constraints:
Length: 1 - 255
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String serialNumber
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
java.lang.String authenticationCode1
Constraints:
Length: 6 - 6
Pattern: [\d]*
java.lang.String authenticationCode2
Constraints:
Length: 6 - 6
Pattern: [\d]*
java.lang.String path
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
java.lang.String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String roleId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String arn
Constraints:
Length: 20 - 2048
java.util.Date createDate
java.lang.String assumeRolePolicyDocument
The returned policy is URL-encoded according to RFC 3986.
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.String path
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
java.lang.String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String roleId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String arn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
java.util.Date createDate
java.lang.String assumeRolePolicyDocument
The returned policy is URL-encoded according to RFC 3986.
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceProfileList
com.amazonaws.internal.ListWithAutoConstructFlag<T> rolePolicyList
java.lang.String arn
Constraints:
Length: 20 - 2048
java.util.Date validUntil
java.util.Date createDate
ServerCertificateMetadata serverCertificateMetadata
java.lang.String certificateBody
Constraints:
Length: 1 - 16384
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.String certificateChain
Constraints:
Length: 1 - 2097152
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]*
java.lang.String path
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
java.lang.String serverCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String serverCertificateId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String arn
Constraints:
Length: 20 - 2048
java.util.Date uploadDate
java.util.Date expiration
java.lang.String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String certificateId
Constraints:
Length: 24 - 128
Pattern: [\w]*
java.lang.String certificateBody
Constraints:
Length: 1 - 16384
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.String status
Active means the
key is valid for API calls, while Inactive means it is
not.
Constraints:
Allowed Values: Active, Inactive
java.util.Date uploadDate
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String status
Active means the key can be used for API calls to AWS,
while Inactive means the key cannot be used.
Constraints:
Allowed Values: Active, Inactive
java.lang.Integer minimumPasswordLength
Default value: 6
Constraints:
Range: 6 - 128
java.lang.Boolean requireSymbols
! @ # $ % ^ & * ( ) _ + - = [ ] { } | '
Default value: false
java.lang.Boolean requireNumbers
Default value: false
java.lang.Boolean requireUppercaseCharacters
Default value: false
java.lang.Boolean requireLowercaseCharacters
Default value: false
java.lang.Boolean allowUsersToChangePassword
Default value: false
java.lang.Integer maxPasswordAge
Default value: 0
Constraints:
Range: 1 - 1095
java.lang.Integer passwordReusePrevention
Default value: 0
Constraints:
Range: 1 - 24
java.lang.Boolean hardExpiry
Default value: false
java.lang.String roleName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String policyDocument
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.String groupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String newPath
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
java.lang.String newGroupName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String password
Constraints:
Length: 1 - 128
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.Boolean passwordResetRequired
java.lang.String openIDConnectProviderArn
Constraints:
Length: 20 - 2048
com.amazonaws.internal.ListWithAutoConstructFlag<T> thumbprintList
java.lang.String sAMLMetadataDocument
Constraints:
Length: 1000 - 10000000
java.lang.String sAMLProviderArn
Constraints:
Length: 20 - 2048
java.lang.String serverCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String newPath
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
java.lang.String newServerCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String certificateId
Constraints:
Length: 24 - 128
Pattern: [\w]*
java.lang.String status
Active
means the certificate can be used for API calls to AWS, while
Inactive means the certificate cannot be used.
Constraints:
Allowed Values: Active, Inactive
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String newPath
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
java.lang.String newUserName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String path
This parameter is
optional. If it is not included, it defaults to a slash (/). --path option. The path must begin with
/cloudfront and must include a trailing slash (for
example, /cloudfront/test/).
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
java.lang.String serverCertificateName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String certificateBody
Constraints:
Length: 1 - 16384
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.String privateKey
Constraints:
Length: 1 - 16384
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]*
java.lang.String certificateChain
Constraints:
Length: 1 - 2097152
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]*
ServerCertificateMetadata serverCertificateMetadata
java.lang.String userName
Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*
java.lang.String certificateBody
Constraints:
Length: 1 - 16384
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
SigningCertificate certificate
java.lang.String path
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
java.lang.String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String userId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String arn
Constraints:
Length: 20 - 2048
java.util.Date createDate
java.util.Date passwordLastUsed
This value is returned only in the GetUser and ListUsers actions.
java.lang.String path
Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)
java.lang.String userName
Constraints:
Length: 1 - 64
Pattern: [\w+=,.@-]*
java.lang.String userId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String arn
For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
Constraints:
Length: 20 - 2048
java.util.Date createDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> userPolicyList
com.amazonaws.internal.ListWithAutoConstructFlag<T> groupList
java.lang.String serialNumber
VirtualMFADevice.
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
java.nio.ByteBuffer base32StringSeed
Base32StringSeed is Base64-encoded.java.nio.ByteBuffer qRCodePNG
otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String
where $virtualMFADeviceName is one of the create call
arguments, AccountName is the user name if set
(otherwise, the account ID otherwise), and Base32String
is the seed in Base32 format. The Base32String value is
Base64-encoded.User user
This data type is used as a response element in the following actions:
java.util.Date enableDate
java.lang.String jobType
Constraints:
Allowed Values: Import, Export
java.lang.String manifest
java.lang.String manifestAddendum
java.lang.Boolean validateOnly
java.lang.String jobId
java.lang.String jobType
Constraints:
Allowed Values: Import, Export
java.lang.String awsShippingAddress
java.lang.String signature
java.lang.String signatureFileContents
java.lang.String warningMessage
java.lang.String jobId
java.lang.String jobType
Constraints:
Allowed Values: Import, Export
java.lang.String awsShippingAddress
java.lang.String locationCode
java.lang.String locationMessage
java.lang.String progressCode
java.lang.String progressMessage
java.lang.String carrier
java.lang.String trackingNumber
java.lang.String logBucket
java.lang.String logKey
java.lang.Integer errorCount
java.lang.String signature
java.lang.String signatureFileContents
java.lang.String currentManifest
java.util.Date creationDate
java.lang.String jobId
java.util.Date creationDate
java.lang.Boolean isCanceled
java.lang.String jobType
Constraints:
Allowed Values: Import, Export
java.lang.Integer maxJobs
java.lang.String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobs
java.lang.Boolean isTruncated
java.lang.String jobId
java.lang.String manifest
java.lang.String jobType
Constraints:
Allowed Values: Import, Export
java.lang.Boolean validateOnly
java.lang.String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
java.lang.Integer shardCount
Note: The default limit for an AWS account is 10 shards per stream. If you need to create a stream with more than 10 shards, contact AWS Support to increase the limit on your account.
Constraints:
Range: 1 -
java.lang.String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
java.lang.Integer limit
Constraints:
Range: 1 - 10000
java.lang.String exclusiveStartShardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
StreamDescription streamDescription
java.lang.String shardIterator
Constraints:
Length: 1 - 512
java.lang.Integer limit
GetRecords throws InvalidArgumentException.
Constraints:
Range: 1 - 10000
com.amazonaws.internal.ListWithAutoConstructFlag<T> records
The data records retrieved from the shard.
java.lang.String nextShardIterator
null, the shard has been
closed and the requested iterator will not return any more data.
Constraints:
Length: 1 - 512
java.lang.String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
java.lang.String shardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
java.lang.String shardIteratorType
The following are the valid shard iterator types:
Constraints:
Allowed Values: AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST
java.lang.String startingSequenceNumber
Constraints:
Pattern: 0|([1-9]\d{0,128})
java.lang.String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
java.lang.String exclusiveStartTagKey
ListTagsForStream gets all tags that
occur after ExclusiveStartTagKey.
Constraints:
Length: 1 - 128
java.lang.Integer limit
HasMoreTags is
set to true. To list additional tags, set
ExclusiveStartTagKey to the last key in the response.
Constraints:
Range: 1 - 10
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
StreamName, starting with
the first tag after ExclusiveStartTagKey and up to the
specified Limit.
Constraints:
Length: 0 -
java.lang.Boolean hasMoreTags
true, more tags are available. To request
additional tags, set ExclusiveStartTagKey to the key of
the last tag returned.java.lang.String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
java.lang.String shardToMerge
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
java.lang.String adjacentShardToMerge
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
java.lang.String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
java.nio.ByteBuffer data
Constraints:
Length: 0 - 51200
java.lang.String partitionKey
Constraints:
Length: 1 - 256
java.lang.String explicitHashKey
Constraints:
Pattern: 0|([1-9]\d{0,38})
java.lang.String sequenceNumberForOrdering
SequenceNumberForOrdering of record n to the
sequence number of record n-1 (as returned in the
PutRecordResult when putting record n-1). If this
parameter is not set, records will be coarsely ordered based on
arrival time.
Constraints:
Pattern: 0|([1-9]\d{0,128})
java.lang.String shardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
java.lang.String sequenceNumber
Constraints:
Pattern: 0|([1-9]\d{0,128})
java.nio.ByteBuffer data
Constraints:
Length: 0 - 51200
java.lang.String explicitHashKey
Constraints:
Pattern: 0|([1-9]\d{0,38})
java.lang.String partitionKey
Constraints:
Length: 1 - 256
java.lang.Integer failedRecordCount
PutRecords request.
Constraints:
Range: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> records
SequenceNumber and ShardId in the result. A
record that fails to be added to your Amazon Kinesis stream includes
ErrorCode and ErrorMessage in the result.
Constraints:
Length: 1 - 500
java.lang.String sequenceNumber
Constraints:
Pattern: 0|([1-9]\d{0,128})
java.lang.String shardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
java.lang.String errorCode
ErrorCodes can be either
ProvisionedThroughputExceededException or
InternalFailure.java.lang.String errorMessage
ErrorCode value of
ProvisionedThroughputExceededException has an error
message that includes the account ID, stream name, and shard ID. An
ErrorCode value of InternalFailure has the
error message "Internal Service Failure".java.lang.String sequenceNumber
Constraints:
Pattern: 0|([1-9]\d{0,128})
java.nio.ByteBuffer data
Constraints:
Length: 0 - 51200
java.lang.String partitionKey
Constraints:
Length: 1 - 256
java.lang.String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
Constraints:
Length: 1 - 10
java.lang.String startingSequenceNumber
Constraints:
Pattern: 0|([1-9]\d{0,128})
java.lang.String endingSequenceNumber
null.
Constraints:
Pattern: 0|([1-9]\d{0,128})
java.lang.String shardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
java.lang.String parentShardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
java.lang.String adjacentParentShardId
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
HashKeyRange hashKeyRange
SequenceNumberRange sequenceNumberRange
java.lang.String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
java.lang.String shardToSplit
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
java.lang.String newStartingHashKey
NewStartingHashKey must be in the range of hash keys
being mapped into the shard. The NewStartingHashKey hash
key value and all higher hash key values in hash key range are
distributed to one of the child shards. All the lower hash key values
in the range are distributed to the other child shard.
Constraints:
Pattern: 0|([1-9]\d{0,38})
java.lang.String streamName
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
java.lang.String streamARN
java.lang.String streamStatus
The stream status is one of the following states:
CREATING - The
stream is being created. Amazon Kinesis immediately returns and sets
StreamStatus to CREATING.DELETING - The stream is being deleted. The specified
stream is in the DELETING state until Amazon Kinesis
completes the deletion.ACTIVE - The stream
exists and is ready for read and write operations or deletion. You
should perform read and write operations only on an
ACTIVE stream.UPDATING - Shards in
the stream are being merged or split. Read and write operations
continue to work while the stream is in the UPDATING
state.
Constraints:
Allowed Values: CREATING, DELETING, ACTIVE, UPDATING
com.amazonaws.internal.ListWithAutoConstructFlag<T> shards
java.lang.Boolean hasMoreShards
true, more shards in the stream are available
to describe.java.lang.String key
Constraints:
Length: 1 - 128
java.lang.String value
Constraints:
Length: 0 - 256
java.lang.String aliasName
Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$
java.lang.String aliasArn
Constraints:
Length: 20 - 2048
java.lang.String targetKeyId
Constraints:
Length: 1 - 256
java.lang.String aliasName
Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$
java.lang.String targetKeyId
Constraints:
Length: 1 - 256
java.lang.String keyId
Constraints:
Length: 1 - 256
java.lang.String granteePrincipal
keyId parameter.
Constraints:
Length: 1 - 256
java.lang.String retiringPrincipal
Constraints:
Length: 1 - 256
com.amazonaws.internal.ListWithAutoConstructFlag<T> operations
GrantConstraints constraints
Operations parameter are allowed.com.amazonaws.internal.ListWithAutoConstructFlag<T> grantTokens
Constraints:
Length: 0 - 10
java.lang.String grantToken
Constraints:
Length: 1 - 8192
java.lang.String grantId
Constraints:
Length: 1 - 128
java.lang.String policy
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.String description
Constraints:
Length: 0 - 8192
java.lang.String keyUsage
Constraints:
Allowed Values: ENCRYPT_DECRYPT
KeyMetadata keyMetadata
java.nio.ByteBuffer ciphertextBlob
Constraints:
Length: 1 - 6144
java.util.Map<K,V> encryptionContext
com.amazonaws.internal.ListWithAutoConstructFlag<T> grantTokens
Constraints:
Length: 0 - 10
java.lang.String keyId
Constraints:
Length: 1 - 256
java.nio.ByteBuffer plaintext
Constraints:
Length: 1 - 4096
KeyMetadata keyMetadata
java.lang.String keyId
Constraints:
Length: 1 - 256
java.nio.ByteBuffer plaintext
Constraints:
Length: 1 - 4096
java.util.Map<K,V> encryptionContext
com.amazonaws.internal.ListWithAutoConstructFlag<T> grantTokens
Constraints:
Length: 0 - 10
java.lang.String keyId
Constraints:
Length: 1 - 256
java.util.Map<K,V> encryptionContext
java.lang.Integer numberOfBytes
Constraints:
Range: 1 - 1024
java.lang.String keySpec
Constraints:
Allowed Values: AES_256, AES_128
com.amazonaws.internal.ListWithAutoConstructFlag<T> grantTokens
Constraints:
Length: 0 - 10
java.nio.ByteBuffer ciphertextBlob
Constraints:
Length: 1 - 6144
java.nio.ByteBuffer plaintext
Constraints:
Length: 1 - 4096
java.lang.String keyId
Constraints:
Length: 1 - 256
java.lang.String keyId
Constraints:
Length: 1 - 256
java.util.Map<K,V> encryptionContext
java.lang.String keySpec
Constraints:
Allowed Values: AES_256, AES_128
java.lang.Integer numberOfBytes
Constraints:
Range: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> grantTokens
Constraints:
Length: 0 - 10
java.nio.ByteBuffer ciphertextBlob
Constraints:
Length: 1 - 6144
java.lang.String keyId
Constraints:
Length: 1 - 256
java.lang.String keyId
Constraints:
Length: 1 - 256
java.lang.String policyName
Constraints:
Length: 1 - 128
Pattern: [\w]+
java.lang.String grantId
Constraints:
Length: 1 - 128
java.lang.String granteePrincipal
Constraints:
Length: 1 - 256
java.lang.String retiringPrincipal
Constraints:
Length: 1 - 256
java.lang.String issuingAccount
Constraints:
Length: 1 - 256
com.amazonaws.internal.ListWithAutoConstructFlag<T> operations
GrantConstraints constraints
Operations parameter are allowed.java.lang.String aWSAccountId
java.lang.String keyId
Constraints:
Length: 1 - 256
java.lang.String arn
Constraints:
Length: 20 - 2048
java.util.Date creationDate
java.lang.Boolean enabled
java.lang.String description
Constraints:
Length: 0 - 8192
java.lang.String keyUsage
Constraints:
Allowed Values: ENCRYPT_DECRYPT
java.lang.Integer limit
Truncated
response element will be set to true.
Constraints:
Range: 1 - 1000
java.lang.String marker
NextMarker element
in the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> aliases
java.lang.String nextMarker
Truncated is true, this value is present and contains
the value to use for the Marker request parameter in a
subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Boolean truncated
Marker request parameter to retrieve
more aliases in the list.java.lang.String keyId
Constraints:
Length: 1 - 256
java.lang.Integer limit
Truncated response element will be set to
true.
Constraints:
Range: 1 - 1000
java.lang.String marker
NextMarker in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> grants
java.lang.String nextMarker
Truncated is true, this value is present and contains
the value to use for the Marker request parameter in a
subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Boolean truncated
Marker request parameter to retrieve
more grants in the list.java.lang.String keyId
Constraints:
Length: 1 - 256
java.lang.Integer limit
Truncated response element will be set to
true.
Constraints:
Range: 1 - 1000
java.lang.String marker
NextMarker in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> policyNames
java.lang.String nextMarker
Truncated is true, this value is present and contains
the value to use for the Marker request parameter in a
subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Boolean truncated
Marker request parameter to retrieve
more policies in the list.java.lang.Integer limit
Truncated response element will be set to
true.
Constraints:
Range: 1 - 1000
java.lang.String marker
NextMarker in
the response you just received.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> keys
java.lang.String nextMarker
Truncated is true, this value is present and contains
the value to use for the Marker request parameter in a
subsequent pagination request.
Constraints:
Length: 1 - 320
Pattern: [\u0020-\u00FF]*
java.lang.Boolean truncated
Marker request parameter to retrieve
more keys in the list.java.lang.String keyId
Constraints:
Length: 1 - 256
java.lang.String policyName
Constraints:
Length: 1 - 128
Pattern: [\w]+
java.lang.String policy
Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.nio.ByteBuffer ciphertextBlob
Constraints:
Length: 1 - 6144
java.util.Map<K,V> sourceEncryptionContext
CiphertextBlob parameter.java.lang.String destinationKeyId
Constraints:
Length: 1 - 256
java.util.Map<K,V> destinationEncryptionContext
com.amazonaws.internal.ListWithAutoConstructFlag<T> grantTokens
Constraints:
Length: 0 - 10
java.nio.ByteBuffer ciphertextBlob
Constraints:
Length: 1 - 6144
java.lang.String sourceKeyId
Constraints:
Length: 1 - 256
java.lang.String keyId
Constraints:
Length: 1 - 256
java.lang.String eventSource
java.lang.String functionName
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9-]+
java.lang.String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_]+
java.lang.Integer batchSize
java.util.Map<K,V> parameters
InitialPositionInStream key. The valid values are:
"TRIM_HORIZON" and "LATEST". The default value is "TRIM_HORIZON". For
more information, go to ShardIteratorType
in the Amazon Kinesis Service API Reference.java.lang.String uUID
java.lang.Integer batchSize
java.lang.String eventSource
java.lang.String functionName
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9-]+
java.util.Map<K,V> parameters
java.lang.String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_]+
java.lang.String lastModified
java.lang.Boolean isActive
java.lang.String status
java.lang.String uUID
java.lang.Integer batchSize
java.lang.String eventSource
java.lang.String functionName
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9-]+
java.util.Map<K,V> parameters
java.lang.String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_]+
java.lang.String lastModified
java.lang.String isActive
java.lang.String status
java.lang.String functionName
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9-]+
java.lang.String functionARN
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-]+(\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?
java.lang.String configurationId
java.lang.String runtime
Constraints:
Allowed Values: nodejs
java.lang.String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_]+
java.lang.String handler
Constraints:
Pattern: [a-zA-Z0-9./\-_]+
java.lang.String mode
Constraints:
Allowed Values: event
java.lang.Long codeSize
java.lang.String description
Constraints:
Length: 0 - 256
java.lang.Integer timeout
Constraints:
Range: 1 - 60
java.lang.Integer memorySize
Constraints:
Range: 64 - 1024
java.lang.String lastModified
java.lang.String uUID
java.lang.Integer batchSize
java.lang.String eventSource
java.lang.String functionName
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9-]+
java.util.Map<K,V> parameters
java.lang.String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_]+
java.lang.String lastModified
java.lang.Boolean isActive
java.lang.String status
java.lang.String functionName
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9-]+
java.lang.String functionARN
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-]+(\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?
java.lang.String configurationId
java.lang.String runtime
Constraints:
Allowed Values: nodejs
java.lang.String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_]+
java.lang.String handler
Constraints:
Pattern: [a-zA-Z0-9./\-_]+
java.lang.String mode
Constraints:
Allowed Values: event
java.lang.Long codeSize
java.lang.String description
Constraints:
Length: 0 - 256
java.lang.Integer timeout
Constraints:
Range: 1 - 60
java.lang.Integer memorySize
Constraints:
Range: 64 - 1024
java.lang.String lastModified
FunctionConfiguration configuration
FunctionCodeLocation code
java.lang.String functionName
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9-]+
java.io.InputStream invokeArgs
java.lang.String eventSourceArn
java.lang.String functionName
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9-]+
java.lang.String marker
ListEventSources operation. If present, specifies to
continue the list from where the returning call left off.java.lang.Integer maxItems
Constraints:
Range: 1 - 10000
java.lang.String marker
ListFunctions operation. If present, indicates where to
continue the listing.java.lang.Integer maxItems
Constraints:
Range: 1 - 10000
java.lang.String functionName
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9-]+
java.lang.String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_]+
java.lang.String handler
Constraints:
Pattern: [a-zA-Z0-9./\-_]+
java.lang.String description
Constraints:
Length: 0 - 256
java.lang.Integer timeout
Constraints:
Range: 1 - 60
java.lang.Integer memorySize
Constraints:
Range: 64 - 1024
java.lang.String functionName
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9-]+
java.lang.String functionARN
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-]+(\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?
java.lang.String configurationId
java.lang.String runtime
Constraints:
Allowed Values: nodejs
java.lang.String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_]+
java.lang.String handler
Constraints:
Pattern: [a-zA-Z0-9./\-_]+
java.lang.String mode
Constraints:
Allowed Values: event
java.lang.Long codeSize
java.lang.String description
Constraints:
Length: 0 - 256
java.lang.Integer timeout
Constraints:
Range: 1 - 60
java.lang.Integer memorySize
Constraints:
Range: 64 - 1024
java.lang.String lastModified
java.lang.String functionName
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9-]+
java.io.InputStream functionZip
java.lang.String runtime
Constraints:
Allowed Values: nodejs
java.lang.String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_]+
java.lang.String handler
Constraints:
Pattern: [a-zA-Z0-9./\-_]+
java.lang.String mode
Constraints:
Allowed Values: event
java.lang.String description
Constraints:
Length: 0 - 256
java.lang.Integer timeout
Constraints:
Range: 1 - 60
java.lang.Integer memorySize
Constraints:
Range: 64 - 1024
java.lang.String functionName
Constraints:
Length: 1 - 64
Pattern: [a-zA-Z0-9-]+
java.lang.String functionARN
Constraints:
Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-]+(\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?
java.lang.String configurationId
java.lang.String runtime
Constraints:
Allowed Values: nodejs
java.lang.String role
Constraints:
Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_]+
java.lang.String handler
Constraints:
Pattern: [a-zA-Z0-9./\-_]+
java.lang.String mode
Constraints:
Allowed Values: event
java.lang.Long codeSize
java.lang.String description
Constraints:
Length: 0 - 256
java.lang.Integer timeout
Constraints:
Range: 1 - 60
java.lang.Integer memorySize
Constraints:
Range: 64 - 1024
java.lang.String lastModified
java.lang.String logGroupNamePrefix
java.lang.String nextToken
DescribeLogGroups request.java.lang.Integer limit
Constraints:
Range: 1 - 50
com.amazonaws.internal.ListWithAutoConstructFlag<T> logGroups
java.lang.String nextToken
java.lang.String logGroupName
java.lang.String logStreamNamePrefix
java.lang.String nextToken
DescribeLogStreams request.java.lang.Integer limit
Constraints:
Range: 1 - 50
com.amazonaws.internal.ListWithAutoConstructFlag<T> logStreams
java.lang.String nextToken
java.lang.String logGroupName
java.lang.String filterNamePrefix
Constraints:
Length: 1 - 512
Pattern: [^:*]*
java.lang.String nextToken
DescribeMetricFilters request.java.lang.Integer limit
Constraints:
Range: 1 - 50
com.amazonaws.internal.ListWithAutoConstructFlag<T> metricFilters
java.lang.String nextToken
java.lang.String logGroupName
java.lang.String logStreamName
java.lang.Long startTime
Constraints:
Range: 0 -
java.lang.Long endTime
Constraints:
Range: 0 -
java.lang.String nextToken
nextForwardToken or nextBackwardToken fields in the response of the
previous GetLogEvents request.java.lang.Integer limit
Constraints:
Range: 1 - 10000
java.lang.Boolean startFromHead
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
java.lang.String nextForwardToken
java.lang.String nextBackwardToken
java.lang.String logGroupName
java.lang.Long creationTime
Constraints:
Range: 0 -
java.lang.Integer retentionInDays
java.lang.Integer metricFilterCount
java.lang.String arn
java.lang.Long storedBytes
java.lang.String logStreamName
java.lang.Long creationTime
Constraints:
Range: 0 -
java.lang.Long firstEventTimestamp
Constraints:
Range: 0 -
java.lang.Long lastEventTimestamp
Constraints:
Range: 0 -
java.lang.Long lastIngestionTime
Constraints:
Range: 0 -
java.lang.String uploadSequenceToken
sequenceToken can only be used once, and
PutLogEvents requests must include the sequenceToken obtained from the response of the
previous request.
Constraints:
Length: 1 -
java.lang.String arn
java.lang.Long storedBytes
java.lang.String filterName
Constraints:
Length: 1 - 512
Pattern: [^:*]*
java.lang.String filterPattern
Constraints:
Length: 0 - 512
com.amazonaws.internal.ListWithAutoConstructFlag<T> metricTransformations
java.lang.Long creationTime
Constraints:
Range: 0 -
java.lang.String metricName
Constraints:
Length: 0 - 255
Pattern: [^:*$]*
java.lang.String metricNamespace
Constraints:
Length: 0 - 255
Pattern: [^:*$]*
java.lang.String metricValue
Constraints:
Length: 0 - 100
java.lang.Long timestamp
Constraints:
Range: 0 -
java.lang.String message
java.lang.Long ingestionTime
Constraints:
Range: 0 -
java.lang.String logGroupName
java.lang.String logStreamName
com.amazonaws.internal.ListWithAutoConstructFlag<T> logEvents
Constraints:
Length: 1 - 1000
java.lang.String sequenceToken
PutLogEvents request.
Constraints:
Length: 1 -
java.lang.String logGroupName
java.lang.String filterName
Constraints:
Length: 1 - 512
Pattern: [^:*]*
java.lang.String filterPattern
Constraints:
Length: 0 - 512
com.amazonaws.internal.ListWithAutoConstructFlag<T> metricTransformations
java.lang.String filterPattern
Constraints:
Length: 0 - 512
com.amazonaws.internal.ListWithAutoConstructFlag<T> logEventMessages
java.lang.String appId
java.lang.String stackId
java.lang.String shortname
java.lang.String name
java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> dataSources
java.lang.String type
Constraints:
Allowed Values: java, rails, php, nodejs, static, other
Source appSource
Source object that describes the app repository.com.amazonaws.internal.ListWithAutoConstructFlag<T> domains
'www.example.com, example.com'java.lang.Boolean enableSsl
SslConfiguration sslConfiguration
SslConfiguration object with the SSL configuration.java.util.Map<K,V> attributes
java.lang.String createdAt
com.amazonaws.internal.ListWithAutoConstructFlag<T> environment
EnvironmentVariable objects that specify
environment variables to be associated with the app. You can specify
up to ten environment variables. After you deploy the app, these
variables are defined on the associated app server instances.java.lang.Integer instanceCount
java.lang.Integer thresholdsWaitTime
Constraints:
Range: 1 - 100
java.lang.Integer ignoreMetricsTime
IgnoreMetricsTime allows you to direct
AWS OpsWorks to not raise any scaling events long enough to get the
new instances online.
Constraints:
Range: 1 - 100
java.lang.Double cpuThreshold
java.lang.Double memoryThreshold
java.lang.Double loadThreshold
java.lang.String sourceStackId
java.lang.String name
java.lang.String region
java.lang.String vpcId
If the VPC ID corresponds
to a default VPC and you have specified either the
DefaultAvailabilityZone or the
DefaultSubnetId parameter only, AWS OpsWorks infers the
value of the other parameter. If you specify neither parameter, AWS
OpsWorks sets these parameters to the first valid Availability Zone
for the specified region and the corresponding default VPC subnet ID,
respectively.
If you specify a nondefault VPC ID, note the following:
DefaultSubnetId.For more information on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2 Classic, see Supported Platforms.
java.util.Map<K,V> attributes
java.lang.String serviceRoleArn
You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.
java.lang.String defaultInstanceProfileArn
java.lang.String defaultOs
Amazon Linux 2014.09, Ubuntu 12.04
LTS, or Ubuntu 14.04 LTS.Custom. You specify the custom AMI you want to use when
you create instances.The default option is the current Amazon Linux version.
java.lang.String hostnameTheme
HostnameTheme is set to
Layer_Dependent, which creates host names by appending
integers to the layer's short name. The other themes are: Baked_GoodsCloudsEuropean_CitiesFruitsGreek_DeitiesLegendary_Creatures_from_JapanPlanets_and_MoonsRoman_DeitiesScottish_IslandsUS_CitiesWild_CatsTo obtain a generated host
name, call GetHostNameSuggestion, which returns a host
name based on the current theme.
java.lang.String defaultAvailabilityZone
DefaultSubnetId, the subnet must be in the same zone. For
more information, see the VpcId parameter description.java.lang.String defaultSubnetId
VpcId parameter. All instances
are launched into this subnet unless you specify otherwise when you
create the instance. If you also specify a value for
DefaultAvailabilityZone, the subnet must be in that zone.
For information on default values and when this parameter is required,
see the VpcId parameter description.java.lang.String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON
StackConfigurationManager configurationManager
ChefConfiguration chefConfiguration
ChefConfiguration object that specifies whether to
enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For
more information, see Create
a New Stack.java.lang.Boolean useCustomCookbooks
java.lang.Boolean useOpsworksSecurityGroups
AWS OpsWorks provides a standard set of
built-in security groups, one for each layer, which are associated
with layers by default. With UseOpsworksSecurityGroups
you can instead provide your own custom security groups.
UseOpsworksSecurityGroups has the following settings:
For more information, see Create a New Stack.
Source customCookbooksSource
java.lang.String defaultSshKeyName
java.lang.Boolean clonePermissions
com.amazonaws.internal.ListWithAutoConstructFlag<T> cloneAppIds
java.lang.String defaultRootDeviceType
Constraints:
Allowed Values: ebs, instance-store
java.lang.String commandId
java.lang.String instanceId
java.lang.String deploymentId
java.lang.String createdAt
java.lang.String acknowledgedAt
java.lang.String completedAt
java.lang.String status
java.lang.Integer exitCode
java.lang.String logUrl
java.lang.String type
deployrollbackstartstoprestartundeployupdate_dependenciesinstall_dependenciesupdate_custom_cookbooksexecute_recipesjava.lang.String stackId
java.lang.String shortname
java.lang.String name
java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> dataSources
java.lang.String type
Constraints:
Allowed Values: java, rails, php, nodejs, static, other
Source appSource
Source object that specifies the app repository.com.amazonaws.internal.ListWithAutoConstructFlag<T> domains
'www.example.com, example.com'java.lang.Boolean enableSsl
SslConfiguration sslConfiguration
SslConfiguration object with the SSL configuration.java.util.Map<K,V> attributes
com.amazonaws.internal.ListWithAutoConstructFlag<T> environment
EnvironmentVariable objects that specify
environment variables to be associated with the app. You can specify
up to ten environment variables. After you deploy the app, these
variables are defined on the associated app server instance.
java.lang.String stackId
java.lang.String appId
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
DeploymentCommand command
DeploymentCommand object that specifies the deployment
command and any associated arguments.java.lang.String comment
java.lang.String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
java.lang.String stackId
com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
java.lang.String instanceType
java.lang.String autoScalingType
Constraints:
Allowed Values: load, timer
java.lang.String hostname
java.lang.String os
Amazon Linux 2014.09, Ubuntu 12.04
LTS, or Ubuntu 14.04 LTS.CustomThe default option is the current
Amazon Linux version. If you set this parameter to
Custom, you must use the CreateInstance action's
AmiId parameter to specify the custom AMI that you want to use. For
more information on the standard operating systems, see Operating
SystemsFor more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
java.lang.String amiId
Os to
Custom.java.lang.String sshKeyName
java.lang.String availabilityZone
java.lang.String virtualizationType
paravirtual or
hvm.java.lang.String subnetId
java.lang.String architecture
x86_64.
Instance types do not necessarily support both architectures. For a
list of the architectures that are supported by the different instance
types, see Instance
Families and Types.
Constraints:
Allowed Values: x86_64, i386
java.lang.String rootDeviceType
Constraints:
Allowed Values: ebs, instance-store
java.lang.Boolean installUpdatesOnBoot
true. To control
when updates are installed, set this value to false. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. We strongly
recommend using the default value of true to ensure that
your instances have the latest security updates.
java.lang.Boolean ebsOptimized
java.lang.String stackId
java.lang.String type
Constraints:
Allowed Values: java-app, lb, web, php-app, rails-app, nodejs-app, memcached, db-master, monitoring-master, custom
java.lang.String name
java.lang.String shortname
java.util.Map<K,V> attributes
java.lang.String customInstanceProfileArn
com.amazonaws.internal.ListWithAutoConstructFlag<T> customSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> packages
Package objects that describe the layer
packages.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeConfigurations
VolumeConfigurations object that describes the layer's
Amazon EBS volumes.java.lang.Boolean enableAutoHealing
java.lang.Boolean autoAssignElasticIps
java.lang.Boolean autoAssignPublicIps
Recipes customRecipes
LayerCustomRecipes object that specifies the layer
custom recipes.java.lang.Boolean installUpdatesOnBoot
true. To control
when updates are installed, set this value to false. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. We strongly
recommend using the default value of true, to ensure that
your instances have the latest security updates.
java.lang.Boolean useEbsOptimizedInstances
LifecycleEventConfiguration lifecycleEventConfiguration
java.lang.String name
java.lang.String region
java.lang.String vpcId
If the VPC ID corresponds to a default
VPC and you have specified either the
DefaultAvailabilityZone or the
DefaultSubnetId parameter only, AWS OpsWorks infers the
value of the other parameter. If you specify neither parameter, AWS
OpsWorks sets these parameters to the first valid Availability Zone
for the specified region and the corresponding default VPC subnet ID,
respectively.
If you specify a nondefault VPC ID, note the following:
DefaultSubnetId.For more information on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2 Classic, see Supported Platforms.
java.util.Map<K,V> attributes
java.lang.String serviceRoleArn
java.lang.String defaultInstanceProfileArn
java.lang.String defaultOs
Amazon Linux 2014.09, Ubuntu 12.04
LTS, or Ubuntu 14.04 LTS.Custom. You specify the custom AMI you want to use when
you create instances.The default option is the current Amazon Linux version.
java.lang.String hostnameTheme
HostnameTheme is set to
Layer_Dependent, which creates host names by appending
integers to the layer's short name. The other themes are: Baked_GoodsCloudsEuropean_CitiesFruitsGreek_DeitiesLegendary_Creatures_from_JapanPlanets_and_MoonsRoman_DeitiesScottish_IslandsUS_CitiesWild_CatsTo obtain a generated host
name, call GetHostNameSuggestion, which returns a host
name based on the current theme.
java.lang.String defaultAvailabilityZone
DefaultSubnetId, the subnet must be in the same zone. For
more information, see the VpcId parameter description.java.lang.String defaultSubnetId
VpcId parameter. All instances
are launched into this subnet unless you specify otherwise when you
create the instance. If you also specify a value for
DefaultAvailabilityZone, the subnet must be in that zone.
For information on default values and when this parameter is required,
see the VpcId parameter description.java.lang.String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
StackConfigurationManager configurationManager
ChefConfiguration chefConfiguration
ChefConfiguration object that specifies whether to
enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For
more information, see Create
a New Stack.java.lang.Boolean useCustomCookbooks
java.lang.Boolean useOpsworksSecurityGroups
AWS OpsWorks provides a standard set of
built-in security groups, one for each layer, which are associated
with layers by default. With UseOpsworksSecurityGroups
you can instead provide your own custom security groups.
UseOpsworksSecurityGroups has the following settings:
For more information, see Create a New Stack.
Source customCookbooksSource
java.lang.String defaultSshKeyName
java.lang.String defaultRootDeviceType
instance-store. For more
information, see Storage
for the Root Device.
Constraints:
Allowed Values: ebs, instance-store
java.lang.String iamUserArn
java.lang.String sshUsername
my.name
will be changed to myname. If you do not specify an SSH
user name, AWS OpsWorks generates one from the IAM user name.java.lang.String sshPublicKey
java.lang.Boolean allowSelfManagement
java.lang.String deploymentId
java.lang.String stackId
java.lang.String appId
java.lang.String createdAt
java.lang.String completedAt
java.lang.Integer duration
java.lang.String iamUserArn
java.lang.String comment
DeploymentCommand command
java.lang.String status
java.lang.String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
java.lang.String name
For stacks, the following commands are available:
execute_recipes: Execute one or more recipes. To
specify the recipes, set an Args parameter named
recipes to the list of recipes to be executed. For
example, to execute phpapp::appsetup, set
Args to
{"recipes":["phpapp::appsetup"]}.install_dependencies: Install the stack's
dependencies.update_custom_cookbooks: Update
the stack's custom cookbooks.update_dependencies: Update the stack's
dependencies.For apps, the following commands are available:
deploy: Deploy an app. Rails apps
have an optional Args parameter named
migrate. Set Args to {"migrate":["true"]} to
migrate the database. The default setting is
{"migrate":["false"]}.rollback Roll the app
back to the previous version. When you update an app, AWS OpsWorks
stores the previous version, up to a maximum of five versions. You can
use this command to roll an app back as many as four versions.start: Start the app's web or application
server.stop: Stop the app's web or application
server.restart: Restart the app's web or
application server.undeploy: Undeploy the
app.
Constraints:
Allowed Values: install_dependencies, update_dependencies, update_custom_cookbooks, execute_recipes, deploy, rollback, start, stop, restart, undeploy
java.util.Map<K,V> args
{"arg_name1" :
["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...],
...}
The update_dependencies command takes two
arguments:
upgrade_os_to - Specifies the desired
Amazon Linux version for instances whose OS you want to upgrade, such
as Amazon Linux 2014.09. You must also set the
allow_reboot argument to true.allow_reboot - Specifies whether to allow AWS
OpsWorks to reboot the instances if necessary, after installing the
updates. This argument can be set to either true or
false. The default value is false.For example, to upgrade an instance to Amazon Linux 2014.09,
set Args to the following. {
"upgrade_os_to":["Amazon Linux 2014.09"], "allow_reboot":["true"] }
java.lang.String stackId
DescribeApps
returns a description of the apps in the specified stack.com.amazonaws.internal.ListWithAutoConstructFlag<T> appIds
DescribeApps returns a description of the
specified apps. Otherwise, it returns a description of every app.java.lang.String deploymentId
DescribeCommands returns a description of the commands
associated with the specified deployment.java.lang.String instanceId
DescribeCommands returns a description of the commands
associated with the specified instance.com.amazonaws.internal.ListWithAutoConstructFlag<T> commandIds
DescribeCommands returns a description of the specified
commands. Otherwise, it returns a description of every command.java.lang.String stackId
DescribeDeployments returns a description of the commands
associated with the specified stack.java.lang.String appId
DescribeDeployments returns a description of the commands
associated with the specified app.com.amazonaws.internal.ListWithAutoConstructFlag<T> deploymentIds
DescribeDeployments returns a description of
the specified deployments. Otherwise, it returns a description of
every deployment.java.lang.String instanceId
DescribeElasticIps returns a description of the Elastic
IP addresses associated with the specified instance.java.lang.String stackId
DescribeElasticIps returns a description of the Elastic
IP addresses that are registered with the specified stack.com.amazonaws.internal.ListWithAutoConstructFlag<T> ips
DescribeElasticIps returns a description of
the specified Elastic IP addresses. Otherwise, it returns a
description of every Elastic IP address.java.lang.String stackId
com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
java.lang.String stackId
DescribeInstances
returns descriptions of the instances associated with the specified
stack.java.lang.String layerId
DescribeInstances
returns descriptions of the instances associated with the specified
layer.com.amazonaws.internal.ListWithAutoConstructFlag<T> instanceIds
DescribeInstances returns a description of the specified
instances. Otherwise, it returns a description of every instance.java.lang.String stackId
com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
DescribeLayers returns a description
of every layer in the specified stack.SelfUserProfile userProfile
UserProfile object that describes the user's SSH
information.java.lang.String iamUserArn
java.lang.String stackId
com.amazonaws.internal.ListWithAutoConstructFlag<T> permissions
Permission objects that describe the stack
permissions. Permission object with permissions
for each of the stack IAM ARNs.Permission
object with permissions for each of the user's stack IDs.Permission object with permissions for the
specified stack and IAM ARN.java.lang.String instanceId
DescribeRaidArrays returns descriptions of the RAID
arrays associated with the specified instance.java.lang.String stackId
com.amazonaws.internal.ListWithAutoConstructFlag<T> raidArrayIds
DescribeRaidArrays returns descriptions of the specified
arrays. Otherwise, it returns a description of every array.java.lang.String stackId
com.amazonaws.internal.ListWithAutoConstructFlag<T> rdsDbInstanceArns
java.lang.String stackId
DescribeServiceErrors returns descriptions of the errors
associated with the specified stack.java.lang.String instanceId
DescribeServiceErrors returns descriptions of the errors
associated with the specified instance.com.amazonaws.internal.ListWithAutoConstructFlag<T> serviceErrorIds
DescribeServiceErrors returns descriptions of the
specified errors. Otherwise, it returns a description of every error.StackSummary stackSummary
StackSummary object that contains the results.java.lang.String instanceId
DescribeVolumes returns descriptions of the volumes
associated with the specified instance.java.lang.String stackId
java.lang.String raidArrayId
DescribeVolumes returns descriptions of the volumes
associated with the specified RAID array.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeIds
DescribeVolumes returns descriptions of the specified
volumes. Otherwise, it returns a description of every volume.java.lang.String ip
java.lang.String name
java.lang.String domain
java.lang.String region
java.lang.String instanceId
java.lang.String elasticLoadBalancerName
java.lang.String region
java.lang.String dnsName
java.lang.String stackId
java.lang.String layerId
java.lang.String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> ec2InstanceIds
java.lang.String key
java.lang.String value
java.lang.Boolean secure
Secure to true.
DescribeApps then returns **Filtered**
instead of the actual value. The default value for Secure
is false.java.lang.String instanceId
java.lang.String ec2InstanceId
java.lang.String virtualizationType
paravirtual or
hvm.
Constraints:
Allowed Values: paravirtual, hvm
java.lang.String hostname
java.lang.String stackId
com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
java.lang.String instanceType
java.lang.String instanceProfileArn
java.lang.String status
bootingconnection_lostonlinependingrebootingrequestedrunning_setupsetup_failedshutting_downstart_failedstoppedstoppingterminatedterminatingjava.lang.String os
java.lang.String amiId
java.lang.String availabilityZone
java.lang.String subnetId
java.lang.String publicDns
java.lang.String privateDns
java.lang.String publicIp
java.lang.String privateIp
java.lang.String elasticIp
java.lang.String autoScalingType
Constraints:
Allowed Values: load, timer
java.lang.String sshKeyName
java.lang.String sshHostRsaKeyFingerprint
java.lang.String sshHostDsaKeyFingerprint
java.lang.String createdAt
java.lang.String lastServiceErrorId
java.lang.String architecture
Constraints:
Allowed Values: x86_64, i386
java.lang.String rootDeviceType
Constraints:
Allowed Values: ebs, instance-store
java.lang.String rootDeviceVolumeId
java.lang.Boolean installUpdatesOnBoot
true. If this value
is set to false, you must then update your instances
manually by using CreateDeployment to run the
update_dependencies stack command or manually running
yum (Amazon Linux) or apt-get (Ubuntu) on
the instances. We strongly recommend using the default value
of true, to ensure that your instances have the latest
security updates.
java.lang.Boolean ebsOptimized
ReportedOs reportedOs
java.lang.String infrastructureClass
ec2
or on-premisesjava.lang.String registeredBy
java.lang.Integer assigning
java.lang.Integer booting
booting status.java.lang.Integer connectionLost
connection_lost status.java.lang.Integer deregistering
java.lang.Integer online
online status.java.lang.Integer pending
pending status.java.lang.Integer rebooting
rebooting status.java.lang.Integer registered
java.lang.Integer registering
java.lang.Integer requested
requested status.java.lang.Integer runningSetup
running_setup status.java.lang.Integer setupFailed
setup_failed status.java.lang.Integer shuttingDown
shutting_down status.java.lang.Integer startFailed
start_failed status.java.lang.Integer stopped
stopped status.java.lang.Integer stopping
stopping status.java.lang.Integer terminated
terminated status.java.lang.Integer terminating
terminating status.java.lang.Integer unassigning
java.lang.String stackId
java.lang.String layerId
java.lang.String type
Constraints:
Allowed Values: java-app, lb, web, php-app, rails-app, nodejs-app, memcached, db-master, monitoring-master, custom
java.lang.String name
java.lang.String shortname
java.util.Map<K,V> attributes
java.lang.String customInstanceProfileArn
com.amazonaws.internal.ListWithAutoConstructFlag<T> customSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> defaultSecurityGroupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> packages
Package objects that describe the layer's
packages.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeConfigurations
VolumeConfigurations object that describes the layer's
Amazon EBS volumes.java.lang.Boolean enableAutoHealing
java.lang.Boolean autoAssignElasticIps
java.lang.Boolean autoAssignPublicIps
Recipes defaultRecipes
LayerCustomRecipes
specifies the custom recipes for a particular layer to be run in
response to each of the five events. To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.
Recipes customRecipes
LayerCustomRecipes object that specifies the layer's
custom recipes.java.lang.String createdAt
java.lang.Boolean installUpdatesOnBoot
true. If this value
is set to false, you must then update your instances
manually by using CreateDeployment to run the
update_dependencies stack command or manually running
yum (Amazon Linux) or apt-get (Ubuntu) on
the instances. We strongly recommend using the default value
of true, to ensure that your instances have the latest
security updates.
java.lang.Boolean useEbsOptimizedInstances
LifecycleEventConfiguration lifecycleEventConfiguration
LifeCycleEventConfiguration object that specifies the
Shutdown event configuration.ShutdownEventConfiguration shutdown
ShutdownEventConfiguration object that specifies the
Shutdown event configuration.java.lang.String layerId
java.lang.Boolean enable
AutoScalingThresholds upScaling
AutoScalingThresholds object that describes the
upscaling configuration, which defines how and when AWS OpsWorks
increases the number of instances.AutoScalingThresholds downScaling
AutoScalingThresholds object that describes the
downscaling configuration, which defines how and when AWS OpsWorks
reduces the number of instances.java.lang.String stackId
java.lang.String iamUserArn
java.lang.Boolean allowSsh
java.lang.Boolean allowSudo
java.lang.String level
denyshowdeploymanageiam_onlyFor more information on the permissions associated with these levels, see Managing User Permissions
java.lang.String raidArrayId
java.lang.String instanceId
java.lang.String name
java.lang.Integer raidLevel
java.lang.Integer numberOfDisks
java.lang.Integer size
java.lang.String device
java.lang.String mountPoint
java.lang.String availabilityZone
java.lang.String createdAt
java.lang.String stackId
java.lang.String volumeType
java.lang.Integer iops
java.lang.String rdsDbInstanceArn
java.lang.String dbInstanceIdentifier
java.lang.String dbUser
java.lang.String dbPassword
java.lang.String region
java.lang.String address
java.lang.String engine
java.lang.String stackId
java.lang.Boolean missingOnRds
true if AWS OpsWorks was unable to discover the
Amazon RDS instance. AWS OpsWorks attempts to discover the instance
only once. If this value is set to true, you must
deregister the instance and then register it again.com.amazonaws.internal.ListWithAutoConstructFlag<T> setup
setup event.com.amazonaws.internal.ListWithAutoConstructFlag<T> configure
configure event.com.amazonaws.internal.ListWithAutoConstructFlag<T> deploy
deploy event.com.amazonaws.internal.ListWithAutoConstructFlag<T> undeploy
undeploy event.com.amazonaws.internal.ListWithAutoConstructFlag<T> shutdown
shutdown event.java.lang.String stackId
java.lang.String hostname
java.lang.String publicIp
java.lang.String privateIp
java.lang.String rsaPublicKey
java.lang.String rsaPublicKeyFingerprint
InstanceIdentity instanceIdentity
java.lang.String serviceErrorId
java.lang.String stackId
java.lang.String instanceId
java.lang.String type
java.lang.String message
java.lang.String createdAt
java.lang.String layerId
java.lang.Boolean enable
AutoScalingThresholds upScaling
AutoScalingThresholds object with the upscaling
threshold configuration. If the load exceeds these thresholds for a
specified amount of time, AWS OpsWorks starts a specified number of
instances.AutoScalingThresholds downScaling
AutoScalingThresholds object with the downscaling
threshold configuration. If the load falls below these thresholds for
a specified amount of time, AWS OpsWorks stops a specified number of
instances.java.lang.String stackId
java.lang.String iamUserArn
java.lang.Boolean allowSsh
java.lang.Boolean allowSudo
java.lang.String level
denyshowdeploymanageiam_onlyFor more information on the permissions associated with these levels, see Managing User Permissions
java.lang.String instanceId
WeeklyAutoScalingSchedule autoScalingSchedule
AutoScalingSchedule with the instance schedule.java.lang.Integer executionTimeout
java.lang.Boolean delayUntilElbConnectionsDrained
java.lang.String type
Constraints:
Allowed Values: git, svn, archive, s3
java.lang.String url
java.lang.String username
Username to the appropriate IAM access key
ID.Username to the user name.java.lang.String password
java.lang.String sshKey
java.lang.String revision
java.lang.String certificate
java.lang.String privateKey
java.lang.String chain
java.lang.String stackId
java.lang.String name
java.lang.String arn
java.lang.String region
java.lang.String vpcId
java.util.Map<K,V> attributes
java.lang.String serviceRoleArn
java.lang.String defaultInstanceProfileArn
java.lang.String defaultOs
java.lang.String hostnameTheme
java.lang.String defaultAvailabilityZone
java.lang.String defaultSubnetId
java.lang.String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
StackConfigurationManager configurationManager
ChefConfiguration chefConfiguration
ChefConfiguration object that specifies whether to
enable Berkshelf and the Berkshelf version. For more information, see
Create
a New Stack.java.lang.Boolean useCustomCookbooks
java.lang.Boolean useOpsworksSecurityGroups
Source customCookbooksSource
java.lang.String defaultSshKeyName
java.lang.String createdAt
java.lang.String defaultRootDeviceType
Constraints:
Allowed Values: ebs, instance-store
java.lang.String stackId
java.lang.String name
java.lang.String arn
java.lang.Integer layersCount
java.lang.Integer appsCount
InstancesCount instancesCount
InstancesCount object with the number of instances in
each status.java.lang.String instanceId
WeeklyAutoScalingSchedule autoScalingSchedule
WeeklyAutoScalingSchedule object with the instance
schedule.java.lang.String appId
java.lang.String name
java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> dataSources
java.lang.String type
Constraints:
Allowed Values: java, rails, php, nodejs, static, other
Source appSource
Source object that specifies the app repository.com.amazonaws.internal.ListWithAutoConstructFlag<T> domains
'www.example.com, example.com'java.lang.Boolean enableSsl
SslConfiguration sslConfiguration
SslConfiguration object with the SSL configuration.java.util.Map<K,V> attributes
com.amazonaws.internal.ListWithAutoConstructFlag<T> environment
EnvironmentVariable objects that specify
environment variables to be associated with the app. You can specify
up to ten environment variables. After you deploy the app, these
variables are defined on the associated app server instances.
java.lang.String instanceId
com.amazonaws.internal.ListWithAutoConstructFlag<T> layerIds
java.lang.String instanceType
java.lang.String autoScalingType
Constraints:
Allowed Values: load, timer
java.lang.String hostname
java.lang.String os
Amazon Linux 2014.09, Ubuntu 12.04
LTS, or Ubuntu 14.04 LTS.CustomThe default option is the current
Amazon Linux version, such as Amazon Linux 2014.09. If
you set this parameter to Custom, you must use the
CreateInstance action's AmiId parameter to specify the custom
AMI that you want to use. For more information on the standard
operating systems, see Operating
SystemsFor more information on how to use custom AMIs with
OpsWorks, see Using
Custom AMIs.
java.lang.String amiId
Os to
Custom.java.lang.String sshKeyName
java.lang.String architecture
Constraints:
Allowed Values: x86_64, i386
java.lang.Boolean installUpdatesOnBoot
true. To control
when updates are installed, set this value to false. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. We strongly
recommend using the default value of true, to ensure that
your instances have the latest security updates.
java.lang.Boolean ebsOptimized
java.lang.String layerId
java.lang.String name
java.lang.String shortname
java.util.Map<K,V> attributes
java.lang.String customInstanceProfileArn
com.amazonaws.internal.ListWithAutoConstructFlag<T> customSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> packages
Package objects that describe the layer's
packages.com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeConfigurations
VolumeConfigurations object that describes the layer's
Amazon EBS volumes.java.lang.Boolean enableAutoHealing
java.lang.Boolean autoAssignElasticIps
java.lang.Boolean autoAssignPublicIps
Recipes customRecipes
LayerCustomRecipes object that specifies the layer's
custom recipes.java.lang.Boolean installUpdatesOnBoot
true. To control
when updates are installed, set this value to false. You
must then update your instances manually by using
CreateDeployment to run the update_dependencies
stack command or manually running yum (Amazon Linux) or
apt-get (Ubuntu) on the instances. We strongly
recommend using the default value of true, to ensure that
your instances have the latest security updates.
java.lang.Boolean useEbsOptimizedInstances
LifecycleEventConfiguration lifecycleEventConfiguration
java.lang.String stackId
java.lang.String name
java.util.Map<K,V> attributes
java.lang.String serviceRoleArn
You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the stack's current service role ARN, if you prefer, but you must do so explicitly.
java.lang.String defaultInstanceProfileArn
java.lang.String defaultOs
Amazon Linux 2014.09, Ubuntu 12.04
LTS, or Ubuntu 14.04 LTS.Custom. You specify the custom AMI you want to use when
you create instances.The default option is the current Amazon Linux version.
java.lang.String hostnameTheme
HostnameTheme is set to
Layer_Dependent, which creates host names by appending
integers to the layer's short name. The other themes are: Baked_GoodsCloudsEuropean_CitiesFruitsGreek_DeitiesLegendary_Creatures_from_JapanPlanets_and_MoonsRoman_DeitiesScottish_IslandsUS_CitiesWild_CatsTo obtain a generated host
name, call GetHostNameSuggestion, which returns a host
name based on the current theme.
java.lang.String defaultAvailabilityZone
DefaultSubnetId, the subnet must be in the same zone. For
more information, see CreateStack.java.lang.String defaultSubnetId
VpcId parameter. All instances
are launched into this subnet unless you specify otherwise when you
create the instance. If you also specify a value for
DefaultAvailabilityZone, the subnet must be in that zone.
For information on default values and when this parameter is required,
see the VpcId parameter description.java.lang.String customJson
"{\"key1\": \"value1\", \"key2\":
\"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
StackConfigurationManager configurationManager
ChefConfiguration chefConfiguration
ChefConfiguration object that specifies whether to
enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For
more information, see Create
a New Stack.java.lang.Boolean useCustomCookbooks
Source customCookbooksSource
java.lang.String defaultSshKeyName
java.lang.String defaultRootDeviceType
Constraints:
Allowed Values: ebs, instance-store
java.lang.Boolean useOpsworksSecurityGroups
AWS OpsWorks provides a standard set of
built-in security groups, one for each layer, which are associated
with layers by default. UseOpsworksSecurityGroups allows
you to instead provide your own custom security groups.
UseOpsworksSecurityGroups has the following settings:
For more information, see Create a New Stack.
java.lang.String iamUserArn
java.lang.String sshUsername
my.name
will be changed to myname. If you do not specify an SSH
user name, AWS OpsWorks generates one from the IAM user name.java.lang.String sshPublicKey
java.lang.Boolean allowSelfManagement
java.lang.String iamUserArn
java.lang.String name
java.lang.String sshUsername
java.lang.String sshPublicKey
java.lang.Boolean allowSelfManagement
java.lang.String volumeId
java.lang.String ec2VolumeId
java.lang.String name
java.lang.String raidArrayId
java.lang.String instanceId
java.lang.String status
java.lang.Integer size
java.lang.String device
java.lang.String mountPoint
java.lang.String region
java.lang.String availabilityZone
java.lang.String volumeType
java.lang.Integer iops
java.lang.String mountPoint
java.lang.Integer raidLevel
java.lang.Integer numberOfDisks
java.lang.Integer size
java.lang.String volumeType
standard - Magneticio1 - Provisioned IOPS (SSD)gp2 - General Purpose (SSD)java.lang.Integer iops
java.util.Map<K,V> monday
java.util.Map<K,V> tuesday
java.util.Map<K,V> wednesday
java.util.Map<K,V> thursday
java.util.Map<K,V> friday
java.util.Map<K,V> saturday
java.util.Map<K,V> sunday
java.lang.String subscriptionName
java.lang.String sourceIdentifier
Constraints:
DBInstanceIdentifier must be supplied.DBSecurityGroupName must be supplied.DBParameterGroupName must be supplied.DBSnapshotIdentifier must
be supplied.java.lang.String resourceName
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String resourceIdentifier
java.lang.String applyAction
java.lang.String optInType
immediate cannot be undone. Valid values:
immediate - Apply the maintenance action
immediately.next-maintenance - Apply the
maintenance action during the next maintenance window for the
resource.undo-opt-in - Cancel any existing
next-maintenance opt-in requests.java.lang.String dBSecurityGroupName
java.lang.String cIDRIP
java.lang.String eC2SecurityGroupName
EC2SecurityGroupId must be provided. Otherwise,
EC2SecurityGroupOwnerId and either EC2SecurityGroupName
or EC2SecurityGroupId must be provided.java.lang.String eC2SecurityGroupId
EC2SecurityGroupId must be provided. Otherwise,
EC2SecurityGroupOwnerId and either EC2SecurityGroupName
or EC2SecurityGroupId must be provided.java.lang.String eC2SecurityGroupOwnerId
EC2SecurityGroupId must be provided. Otherwise,
EC2SecurityGroupOwnerId and either EC2SecurityGroupName
or EC2SecurityGroupId must be provided.java.lang.String sourceDBParameterGroupIdentifier
Constraints:
my-db-param-group, or a valid ARN.arn:aws:rds:us-west-2:123456789012:pg:special-parameters.java.lang.String targetDBParameterGroupIdentifier
Constraints:
Example:
my-db-parameter-group
java.lang.String targetDBParameterGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String sourceDBSnapshotIdentifier
Constraints:
Example:
rds:mydb-2012-04-02-00-01
Example:
arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805
java.lang.String targetDBSnapshotIdentifier
Constraints:
Example: my-db-snapshot
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String sourceOptionGroupIdentifier
Constraints:
my-option-group, or a valid
ARN.arn:aws:rds:us-west-2:123456789012:og:special-options.java.lang.String targetOptionGroupIdentifier
Constraints:
Example:
my-option-group
java.lang.String targetOptionGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String dBInstanceIdentifier
java.lang.String sourceDBInstanceIdentifier
Constraints:
java.lang.String dBInstanceClass
Valid Values:
db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge |
db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium |
db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large |
db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge |
db.t2.micro | db.t2.small | db.t2.medium
Default: Inherits from the source DB instance.
java.lang.String availabilityZone
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example: us-east-1d
java.lang.Integer port
Default: Inherits from the source DB instance
Valid Values:
1150-65535
java.lang.Boolean autoMinorVersionUpgrade
Default: Inherits from the source DB instance
java.lang.Integer iops
java.lang.String optionGroupName
java.lang.Boolean publiclyAccessible
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String dBSubnetGroupName
Constraints:
java.lang.String storageType
Valid values: standard | gp2 | io1
If you specify
io1, you must also include a value for the
Iops parameter.
Default: io1 if the
Iops parameter is specified; otherwise
standard
java.lang.String dBName
Type: String
MySQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Oracle
The Oracle System ID (SID) of the created DB instance.
Default: ORCL
Constraints:
SQL Server
Not applicable. Must be null.
java.lang.String dBInstanceIdentifier
Constraints:
Example:
mydbinstance
java.lang.Integer allocatedStorage
Type: Integer
MySQL
Constraints: Must be an integer from 5 to 3072.
PostgreSQL
Constraints: Must be an integer from 5 to 3072.
Oracle
Constraints: Must be an integer from 10 to 3072.
SQL Server
Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or from 20 to 1024 (Express Edition and Web Edition)
java.lang.String dBInstanceClass
Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large |
db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge |
db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge |
db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge |
db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
java.lang.String engine
Valid Values: MySQL | oracle-se1 |
oracle-se | oracle-ee |
sqlserver-ee | sqlserver-se |
sqlserver-ex | sqlserver-web |
postgres
Not every database engine is available for every AWS region.
java.lang.String masterUsername
MySQL
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
java.lang.String masterUserPassword
Type: String
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
SQL Server
Constraints: Must contain from 8 to 128 characters.
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
Default: The default DB security group for the database engine.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Default: The default EC2 VPC security group for the DB subnet group's VPC.
java.lang.String availabilityZone
Default: A random, system-chosen Availability Zone in the endpoint's region.
Example:
us-east-1d
Constraint: The AvailabilityZone parameter
cannot be specified if the MultiAZ parameter is set to
true. The specified Availability Zone must be in the same
region as the current endpoint.
java.lang.String dBSubnetGroupName
If there is no DB subnet group, then it is a non-VPC DB instance.
java.lang.String preferredMaintenanceWindow
Format:
ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
java.lang.String dBParameterGroupName
Constraints:
java.lang.Integer backupRetentionPeriod
Default: 1
Constraints:
java.lang.String preferredBackupWindow
BackupRetentionPeriod parameter. For more information,
see DB
Instance Backups. Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.
Constraints: Must be in the format
hh24:mi-hh24:mi. Times should be Universal Time
Coordinated (UTC). Must not conflict with the preferred maintenance
window. Must be at least 30 minutes.
java.lang.Integer port
MySQL
Default: 3306
Valid Values:
1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for 1434, 3389, 47001,
49152, and 49152 through 49156.
java.lang.Boolean multiAZ
java.lang.String engineVersion
The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region.
MySQL
5.1.45 | 5.1.49 | 5.1.50 | 5.1.57 | 5.1.61 | 5.1.62 | 5.1.63 | 5.1.69
| 5.1.71 | 5.1.73 5.5.12 |
5.5.20 | 5.5.23 | 5.5.25a | 5.5.27 | 5.5.31 | 5.5.33 | 5.5.37 | 5.5.38
| 5.5.8 5.6.12 | 5.6.13 |
5.6.17 | 5.6.19 | 5.6.21Oracle Database Enterprise Edition (oracle-ee)
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 |
11.2.0.2.v7 | 11.2.0.3.v1 | 11.2.0.4.v1Oracle Database Standard Edition (oracle-se)
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6
| 11.2.0.2.v7 | 11.2.0.3.v1 | 11.2.0.4.v1Oracle Database Standard Edition One (oracle-se1)
11.2.0.2.v3 | 11.2.0.2.v4 |
11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7 | 11.2.0.3.v1 |
11.2.0.4.v1PostgreSQL
9.3.1 | 9.3.2 | 9.3.3Microsoft SQL Server Enterprise Edition (sqlserver-ee)
10.50.2789.0.v1 11.00.2100.60.v1Microsoft SQL Server Express Edition (sqlserver-ex)
10.50.2789.0.v1 11.00.2100.60.v1Microsoft SQL Server Standard Edition (sqlserver-se)
10.50.2789.0.v1 11.00.2100.60.v1Microsoft SQL Server Web Edition (sqlserver-web)
10.50.2789.0.v1 11.00.2100.60.v1java.lang.Boolean autoMinorVersionUpgrade
Default:
true
java.lang.String licenseModel
Valid values:
license-included | bring-your-own-license |
general-public-license
java.lang.Integer iops
Constraints: To use PIOPS, this value must be an integer greater than 1000.
java.lang.String optionGroupName
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
java.lang.String characterSetName
java.lang.Boolean publiclyAccessible
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String storageType
Valid values: standard | gp2 | io1
If you specify
io1, you must also include a value for the
Iops parameter.
Default: io1 if the
Iops parameter is specified; otherwise
standard
java.lang.String tdeCredentialArn
java.lang.String tdeCredentialPassword
java.lang.Boolean storageEncrypted
Default: false
java.lang.String kmsKeyId
The KMS key identifier is the Amazon Resoure Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted parameter is true, and
you do not specify a value for the KmsKeyId parameter,
then Amazon RDS will use your default encryption key. AWS KMS creates
the default encryption key for your AWS account. Your AWS account has
a different default encryption key for each AWS region.
java.lang.String dBParameterGroupName
Constraints:
java.lang.String dBParameterGroupFamily
java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String dBSecurityGroupName
Constraints:
Example: mysecuritygroup
java.lang.String dBSecurityGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String dBSnapshotIdentifier
Constraints:
Example: my-snapshot-id
java.lang.String dBInstanceIdentifier
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String dBSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".
Example:
mySubnetgroup
java.lang.String dBSubnetGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String subscriptionName
Constraints: The name must be less than 255 characters.
java.lang.String snsTopicArn
java.lang.String sourceType
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIds
Constraints:
DBInstanceIdentifier must
be supplied.DBSecurityGroupName must be supplied.DBParameterGroupName must be supplied.DBSnapshotIdentifier must
be supplied.java.lang.Boolean enabled
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String optionGroupName
Constraints:
Example:
myoptiongroup
java.lang.String engineName
java.lang.String majorEngineVersion
java.lang.String optionGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String engine
java.lang.String engineVersion
java.lang.String dBParameterGroupFamily
java.lang.String dBEngineDescription
java.lang.String dBEngineVersionDescription
CharacterSet defaultCharacterSet
CharacterSetName parameter of the CreateDBInstance
API is not specified.com.amazonaws.internal.ListWithAutoConstructFlag<T> supportedCharacterSets
CharacterSetName parameter of the CreateDBInstance API.java.lang.String dBInstanceIdentifier
java.lang.String dBInstanceClass
java.lang.String engine
java.lang.String dBInstanceStatus
java.lang.String masterUsername
java.lang.String dBName
MySQL, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
Endpoint endpoint
java.lang.Integer allocatedStorage
java.util.Date instanceCreateTime
java.lang.String preferredBackupWindow
BackupRetentionPeriod.java.lang.Integer backupRetentionPeriod
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
DBSecurityGroup.Name and
DBSecurityGroup.Status subelements.com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBParameterGroups
java.lang.String availabilityZone
DBSubnetGroup dBSubnetGroup
java.lang.String preferredMaintenanceWindow
PendingModifiedValues pendingModifiedValues
java.util.Date latestRestorableTime
java.lang.Boolean multiAZ
java.lang.String engineVersion
java.lang.Boolean autoMinorVersionUpgrade
java.lang.String readReplicaSourceDBInstanceIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> readReplicaDBInstanceIdentifiers
java.lang.String licenseModel
java.lang.Integer iops
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupMemberships
java.lang.String characterSetName
java.lang.String secondaryAvailabilityZone
java.lang.Boolean publiclyAccessible
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
com.amazonaws.internal.ListWithAutoConstructFlag<T> statusInfos
java.lang.String storageType
java.lang.String tdeCredentialArn
java.lang.Boolean storageEncrypted
java.lang.String kmsKeyId
StorageEncrypted is true, the KMS key identifier for
the encrypted DB instance.java.lang.String dbiResourceId
StorageEncrypted is true, the region-unique, immutable
identifier for the encrypted DB instance. This identifier is found in
AWS CloudTrail log entries whenever the KMS key for the DB instance is
accessed.java.lang.String statusType
java.lang.Boolean normal
java.lang.String status
java.lang.String message
java.lang.String dBParameterGroupName
java.lang.String dBParameterGroupFamily
java.lang.String description
java.lang.String ownerId
java.lang.String dBSecurityGroupName
java.lang.String dBSecurityGroupDescription
java.lang.String vpcId
com.amazonaws.internal.ListWithAutoConstructFlag<T> eC2SecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> iPRanges
java.lang.String dBSnapshotIdentifier
java.lang.String dBInstanceIdentifier
java.util.Date snapshotCreateTime
java.lang.String engine
java.lang.Integer allocatedStorage
java.lang.String status
java.lang.Integer port
java.lang.String availabilityZone
java.lang.String vpcId
java.util.Date instanceCreateTime
java.lang.String masterUsername
java.lang.String engineVersion
java.lang.String licenseModel
java.lang.String snapshotType
java.lang.Integer iops
java.lang.String optionGroupName
java.lang.Integer percentProgress
java.lang.String sourceRegion
java.lang.String storageType
java.lang.String tdeCredentialArn
java.lang.Boolean encrypted
java.lang.String kmsKeyId
Encrypted is true, the KMS key identifier for the
encrypted DB snapshot.java.lang.String dBSubnetGroupName
java.lang.String dBSubnetGroupDescription
java.lang.String vpcId
java.lang.String subnetGroupStatus
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
java.lang.String dBInstanceIdentifier
Constraints:
java.lang.Boolean skipFinalSnapshot
true is specified, no DBSnapshot
is created. If false is specified, a DB snapshot is
created before the DB instance is deleted. Specify
true when deleting a Read Replica. false.
Default:
false
java.lang.String finalDBSnapshotIdentifier
false. Constraints:
java.lang.String dBSecurityGroupName
Constraints:
java.lang.String dBSubnetGroupName
Constraints:
java.lang.String engine
java.lang.String engineVersion
Example: 5.1.49
java.lang.String dBParameterGroupFamily
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
java.lang.Integer maxRecords
MaxRecords value is available, a pagination token
called a marker is included in the response so that the following
results can be retrieved. Default: 100
Constraints: minimum 20, maximum 100
java.lang.String marker
MaxRecords.java.lang.Boolean defaultOnly
java.lang.Boolean listSupportedCharacterSets
java.lang.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBEngineVersions
DBEngineVersion elements.java.lang.String dBInstanceIdentifier
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
java.lang.Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
java.lang.String marker
MaxRecords .java.lang.String marker
MaxRecords .com.amazonaws.internal.ListWithAutoConstructFlag<T> dBInstances
java.lang.String logFileName
java.lang.Long lastWritten
java.lang.Long size
java.lang.String dBInstanceIdentifier
Constraints:
java.lang.String filenameContains
java.lang.Long fileLastWritten
java.lang.Long fileSize
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
java.lang.Integer maxRecords
java.lang.String marker
java.lang.String dBParameterGroupName
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
java.lang.Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
java.lang.String marker
DescribeDBParameterGroups request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.java.lang.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBParameterGroups
java.lang.String dBParameterGroupName
Constraints:
java.lang.String source
Default: All parameter types returned
Valid Values: user | system | engine-default
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
java.lang.Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
java.lang.String marker
DescribeDBParameters request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
java.lang.String marker
MaxRecords.java.lang.String dBSecurityGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
java.lang.Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
java.lang.String marker
MaxRecords.java.lang.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
java.lang.String dBInstanceIdentifier
DBSnapshotIdentifier.
This parameter is not case sensitive. Constraints:
java.lang.String dBSnapshotIdentifier
DBInstanceIdentifier. This value is
stored as a lowercase string. Constraints:
SnapshotType parameter must also be specified.java.lang.String snapshotType
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
java.lang.Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
java.lang.String marker
DescribeDBSnapshots request. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.java.lang.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSnapshots
java.lang.String dBSubnetGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
java.lang.Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
java.lang.String marker
MaxRecords.java.lang.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSubnetGroups
java.lang.String dBParameterGroupFamily
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
java.lang.Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
java.lang.String marker
DescribeEngineDefaultParameters request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.java.lang.String sourceType
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
java.lang.String sourceIdentifier
Constraints:
DBInstance, then a DBInstanceIdentifier must
be supplied.DBSecurityGroup, a DBSecurityGroupName must
be supplied.DBParameterGroup, a DBParameterGroupName
must be supplied.DBSnapshot, a DBSnapshotIdentifier must be
supplied.java.lang.String sourceType
Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot
java.util.Date startTime
Example: 2009-07-08T18:00Z
java.util.Date endTime
Example: 2009-07-08T18:00Z
java.lang.Integer duration
Default: 60
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
java.lang.Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results may be retrieved. Default: 100
Constraints: minimum 20, maximum 100
java.lang.String marker
MaxRecords.java.lang.String marker
MaxRecords .com.amazonaws.internal.ListWithAutoConstructFlag<T> events
java.lang.String subscriptionName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
java.lang.Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: minimum 20, maximum 100
java.lang.String marker
MaxRecords .java.lang.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> eventSubscriptionsList
java.lang.String engineName
java.lang.String majorEngineVersion
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
java.lang.Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: minimum 20, maximum 100
java.lang.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupOptions
java.lang.String marker
MaxRecords.java.lang.String optionGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
java.lang.String marker
MaxRecords.java.lang.Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: minimum 20, maximum 100
java.lang.String engineName
java.lang.String majorEngineVersion
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupsList
java.lang.String marker
MaxRecords.java.lang.String engine
java.lang.String engineVersion
java.lang.String dBInstanceClass
java.lang.String licenseModel
java.lang.Boolean vpc
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
java.lang.Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: minimum 20, maximum 100
java.lang.String marker
MaxRecords .com.amazonaws.internal.ListWithAutoConstructFlag<T> orderableDBInstanceOptions
java.lang.String marker
MaxRecords .java.lang.String resourceIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
db-instance-id - Accepts DB
instance identifiers and DB instance ARNs. The result list will only
include maintenance actions for the specified DB Instances.java.lang.String marker
DescribePendingMaintenanceActions request. If this
parameter is specified, the response includes only records beyond the
marker, up to a number of records specified by MaxRecords
.java.lang.Integer maxRecords
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: minimum 20, maximum 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> pendingMaintenanceActions
java.lang.String marker
DescribePendingMaintenanceActions request. If this
parameter is specified, the response includes only records beyond the
marker, up to a number of records specified by MaxRecords
.java.lang.String reservedDBInstancesOfferingId
Example:
438012d3-4052-4cc7-b2e3-8d3372e0e706
java.lang.String dBInstanceClass
java.lang.String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
java.lang.String productDescription
java.lang.String offeringType
Valid
Values: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
java.lang.Boolean multiAZ
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
java.lang.Integer maxRecords
MaxRecords value is available, a pagination token
called a marker is included in the response so that the following
results can be retrieved. Default: 100
Constraints: minimum 20, maximum 100
java.lang.String marker
MaxRecords.java.lang.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedDBInstancesOfferings
java.lang.String reservedDBInstanceId
java.lang.String reservedDBInstancesOfferingId
java.lang.String dBInstanceClass
java.lang.String duration
Valid
Values: 1 | 3 | 31536000 | 94608000
java.lang.String productDescription
java.lang.String offeringType
Valid
Values: "Light Utilization" | "Medium Utilization" | "Heavy
Utilization"
java.lang.Boolean multiAZ
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
java.lang.Integer maxRecords
MaxRecords value is available, a pagination token
called a marker is included in the response so that the following
results can be retrieved. Default: 100
Constraints: minimum 20, maximum 100
java.lang.String marker
MaxRecords.java.lang.String marker
MaxRecords.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedDBInstances
java.lang.String dBInstanceIdentifier
Constraints:
java.lang.String logFileName
java.lang.String marker
java.lang.Integer numberOfLines
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.
If neither Marker or NumberOfLines are specified, the entire log file is returned.
If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned.
If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.
You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.
java.lang.String logFileData
java.lang.String marker
java.lang.Boolean additionalDataPending
java.lang.String status
java.lang.String eC2SecurityGroupName
java.lang.String eC2SecurityGroupId
java.lang.String eC2SecurityGroupOwnerId
EC2SecurityGroupName field.java.lang.String dBParameterGroupFamily
java.lang.String marker
MaxRecords .com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
java.lang.String sourceIdentifier
java.lang.String sourceType
Constraints:
Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot
java.lang.String message
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
java.util.Date date
java.lang.String customerAwsId
java.lang.String custSubscriptionId
java.lang.String snsTopicArn
java.lang.String status
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
java.lang.String subscriptionCreationTime
java.lang.String sourceType
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIdsList
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategoriesList
java.lang.Boolean enabled
java.lang.String resourceName
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
java.lang.String dBInstanceIdentifier
Constraints:
java.lang.Integer allocatedStorage
ApplyImmediately is set to
true for this request. MySQL
Default: Uses existing setting
Valid Values: 5-3072
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
PostgreSQL
Default: Uses existing setting
Valid Values: 5-3072
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Type: Integer
Oracle
Default: Uses existing setting
Valid Values: 10-3072
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
SQL Server
Cannot be modified.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.
java.lang.String dBInstanceClass
Passing
a value for this setting causes an outage during the change and is
applied during the next maintenance window, unless
ApplyImmediately is specified as true for
this request.
Default: Uses existing setting
Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large |
db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge |
db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge |
db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge |
db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Constraints:
java.lang.Boolean applyImmediately
PreferredMaintenanceWindow setting for
the DB instance. If this parameter is set to false,
changes to the DB instance are applied during the next maintenance
window. Some parameter changes can cause an outage and will be applied
on the next call to RebootDBInstance, or the next failure
reboot. Review the table of parameters in Modifying
a DB Instance and Using the Apply Immediately Parameter to see the
impact that setting ApplyImmediately to true
or false has for each modified parameter and to determine
when the changes will be applied.
Default: false
java.lang.String masterUserPassword
Changing this parameter
does not result in an outage and the change is asynchronously applied
as soon as possible. Between the time of the request and the
completion of the request, the MasterUserPassword element
exists in the PendingModifiedValues element of the
operation response.
Default: Uses existing setting
Constraints:
Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric
characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).
java.lang.String dBParameterGroupName
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
java.lang.Integer backupRetentionPeriod
Changing this parameter can result in
an outage if you change from 0 to a non-zero value or from a non-zero
value to 0. These changes are applied during the next maintenance
window unless the ApplyImmediately parameter is set to
true for this request. If you change the parameter from
one non-zero value to another non-zero value, the change is
asynchronously applied as soon as possible.
Default: Uses existing setting
Constraints:
java.lang.String preferredBackupWindow
BackupRetentionPeriod. Changing this parameter does not
result in an outage and the change is asynchronously applied as soon
as possible. Constraints:
java.lang.String preferredMaintenanceWindow
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
java.lang.Boolean multiAZ
ApplyImmediately parameter is set to true
for this request. Constraints: Cannot be specified if the DB instance is a Read Replica.
java.lang.String engineVersion
ApplyImmediately
parameter is set to true for this request. For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
For a list of valid engine versions, see CreateDBInstance.
java.lang.Boolean allowMajorVersionUpgrade
Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
java.lang.Boolean autoMinorVersionUpgrade
true during the
maintenance window, and a newer minor version is available, and RDS
has enabled auto patching for that engine version.java.lang.Integer iops
ApplyImmediately parameter is set to true
for this request. Default: Uses existing setting
Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
Type: Integer
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.
java.lang.String optionGroupName
ApplyImmediately parameter
is set to true for this request. If the parameter change
results in an option group that enables OEM, this change can cause a
brief (sub-second) period during which new connections are rejected
but existing connections are not interrupted. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
java.lang.String newDBInstanceIdentifier
Apply
Immediately to true, or will occur during the next maintenance
window if Apply Immediately to false. This value is
stored as a lowercase string. Constraints:
java.lang.String storageType
Valid values: standard | gp2 | io1
If you specify
io1, you must also include a value for the
Iops parameter.
Default: io1 if the
Iops parameter is specified; otherwise
standard
java.lang.String tdeCredentialArn
java.lang.String tdeCredentialPassword
java.lang.String dBParameterGroupName
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Valid Values (for
the application method): immediate | pending-reboot
java.lang.String dBSubnetGroupName
Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".
Example:
mySubnetgroup
java.lang.String dBSubnetGroupDescription
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
java.lang.String subscriptionName
java.lang.String snsTopicArn
java.lang.String sourceType
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
java.lang.Boolean enabled
java.lang.String optionGroupName
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToInclude
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToRemove
java.lang.Boolean applyImmediately
java.lang.String optionName
java.lang.String optionDescription
java.lang.Boolean persistent
java.lang.Boolean permanent
java.lang.Integer port
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupMemberships
java.lang.String optionName
java.lang.Integer port
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
java.lang.String optionGroupName
java.lang.String optionGroupDescription
java.lang.String engineName
java.lang.String majorEngineVersion
com.amazonaws.internal.ListWithAutoConstructFlag<T> options
java.lang.Boolean allowsVpcAndNonVpcInstanceMemberships
true indicates the option
group can be applied to both VPC and non-VPC instances.java.lang.String vpcId
false,
this field is blank. If AllowsVpcAndNonVpcInstanceMemberships
is true and this field is blank, then this option group
can be applied to both VPC and non-VPC instances. If this field
contains a value, then this option group can only be applied to
instances that are in the VPC indicated by this field.java.lang.String name
java.lang.String description
java.lang.String engineName
java.lang.String majorEngineVersion
java.lang.String minimumRequiredMinorEngineVersion
java.lang.Boolean portRequired
java.lang.Integer defaultPort
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsDependedOn
java.lang.Boolean persistent
java.lang.Boolean permanent
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupOptionSettings
java.lang.String settingName
java.lang.String settingDescription
java.lang.String defaultValue
java.lang.String applyType
java.lang.String allowedValues
java.lang.Boolean isModifiable
java.lang.String name
java.lang.String value
java.lang.String defaultValue
java.lang.String description
java.lang.String applyType
java.lang.String dataType
java.lang.String allowedValues
java.lang.Boolean isModifiable
java.lang.Boolean isCollection
java.lang.String engine
java.lang.String engineVersion
java.lang.String dBInstanceClass
java.lang.String licenseModel
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
java.lang.Boolean multiAZCapable
java.lang.Boolean readReplicaCapable
java.lang.Boolean vpc
java.lang.Boolean supportsStorageEncryption
java.lang.String storageType
java.lang.Boolean supportsIops
java.lang.String parameterName
java.lang.String parameterValue
java.lang.String description
java.lang.String source
java.lang.String applyType
java.lang.String dataType
java.lang.String allowedValues
java.lang.Boolean isModifiable
true) or not (false) the
parameter can be modified. Some parameters have security or
operational implications that prevent them from being changed.java.lang.String minimumEngineVersion
java.lang.String applyMethod
Constraints:
Allowed Values: immediate, pending-reboot
java.lang.String action
java.util.Date autoAppliedAfterDate
next-maintenance opt-in requests are ignored.java.util.Date forcedApplyDate
immediate opt-in requests are ignored.java.lang.String optInStatus
java.util.Date currentApplyDate
AutoAppliedAfterDate, and the
ForcedApplyDate. This value is blank if an opt-in request
has not been received and no value has been specified for the
AutoAppliedAfterDate or ForcedApplyDate.java.lang.String dBInstanceClass
DBInstanceClass for the DB instance that
will be applied or is in progress.java.lang.Integer allocatedStorage
AllocatedStorage size for the DB
instance that will be applied or is in progress.java.lang.String masterUserPassword
java.lang.Integer port
java.lang.Integer backupRetentionPeriod
java.lang.Boolean multiAZ
java.lang.String engineVersion
java.lang.Integer iops
java.lang.String dBInstanceIdentifier
DBInstanceIdentifier for the DB instance
that will be applied or is in progress.java.lang.String storageType
java.lang.String dBInstanceIdentifier
Constraints:
Example:
java.lang.Integer backupRetentionPeriod
Default: 1
Constraints:
java.lang.String preferredBackupWindow
BackupRetentionPeriod parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.
Constraints: Must
be in the format hh24:mi-hh24:mi. Times should be
Universal Time Coordinated (UTC). Must not conflict with the preferred
maintenance window. Must be at least 30 minutes.
java.lang.String reservedDBInstancesOfferingId
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
java.lang.String reservedDBInstanceId
Example: myreservationID
java.lang.Integer dBInstanceCount
Default: 1
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String dBInstanceIdentifier
Constraints:
java.lang.Boolean forceFailover
true, the reboot will be conducted through a MultiAZ
failover. Constraint: You cannot specify true if the
instance is not configured for MultiAZ.
java.lang.String subscriptionName
java.lang.String sourceIdentifier
java.lang.String resourceName
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
java.lang.String reservedDBInstanceId
java.lang.String reservedDBInstancesOfferingId
java.lang.String dBInstanceClass
java.util.Date startTime
java.lang.Integer duration
java.lang.Double fixedPrice
java.lang.Double usagePrice
java.lang.String currencyCode
java.lang.Integer dBInstanceCount
java.lang.String productDescription
java.lang.String offeringType
java.lang.Boolean multiAZ
java.lang.String state
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
java.lang.String reservedDBInstancesOfferingId
java.lang.String dBInstanceClass
java.lang.Integer duration
java.lang.Double fixedPrice
java.lang.Double usagePrice
java.lang.String currencyCode
java.lang.String productDescription
java.lang.String offeringType
java.lang.Boolean multiAZ
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
java.lang.String dBParameterGroupName
Constraints:
java.lang.Boolean resetAllParameters
true) or not (false) to
reset all parameters in the DB parameter group to default values.
Default: true
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
MySQL
Valid Values (for Apply method): immediate |
pending-reboot
You can use the immediate value with
dynamic parameters only. You can use the pending-reboot
value for both dynamic and static parameters, and changes are applied
when DB instance reboots.
Oracle
Valid Values (for Apply
method): pending-reboot
java.lang.String resourceIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> pendingMaintenanceActionDetails
java.lang.String dBInstanceIdentifier
Constraints:
Example: my-snapshot-id
java.lang.String dBSnapshotIdentifier
Constraints:
java.lang.String dBInstanceClass
Valid Values: db.t1.micro | db.m1.small | db.m1.medium |
db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge |
db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge |
db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge |
db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
java.lang.Integer port
Default: The same port as the original DB instance
Constraints: Value must
be 1150-65535
java.lang.String availabilityZone
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if
the MultiAZ parameter is set to true.
Example:
us-east-1a
java.lang.String dBSubnetGroupName
java.lang.Boolean multiAZ
Constraint:
You cannot specify the AvailabilityZone parameter if the MultiAZ
parameter is set to true.
java.lang.Boolean publiclyAccessible
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
java.lang.Boolean autoMinorVersionUpgrade
java.lang.String licenseModel
Default: Same as source.
Valid values: license-included |
bring-your-own-license |
general-public-license
java.lang.String dBName
This parameter doesn't apply to the MySQL engine.
java.lang.String engine
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values: MySQL | oracle-se1
| oracle-se | oracle-ee |
sqlserver-ee | sqlserver-se |
sqlserver-ex | sqlserver-web |
postgres
java.lang.Integer iops
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
java.lang.String optionGroupName
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String storageType
Valid values: standard | gp2 | io1
If you specify
io1, you must also include a value for the
Iops parameter.
Default: io1 if the
Iops parameter is specified; otherwise
standard
java.lang.String tdeCredentialArn
java.lang.String tdeCredentialPassword
java.lang.String sourceDBInstanceIdentifier
Constraints:
java.lang.String targetDBInstanceIdentifier
Constraints:
java.util.Date restoreTime
Valid Values: Value must be a UTC time
Constraints:
Example:
2009-09-07T23:45:00Z
java.lang.Boolean useLatestRestorableTime
true) or not (false) the
DB instance is restored from the latest backup time. Default:
false
Constraints: Cannot be specified if RestoreTime parameter is provided.
java.lang.String dBInstanceClass
Valid Values: db.t1.micro | db.m1.small | db.m1.medium |
db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge |
db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge |
db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge |
db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium
Default: The same DBInstanceClass as the original DB instance.
java.lang.Integer port
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
java.lang.String availabilityZone
Default: A random, system-chosen Availability Zone.
Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example:
us-east-1a
java.lang.String dBSubnetGroupName
java.lang.Boolean multiAZ
Constraint:
You cannot specify the AvailabilityZone parameter if the MultiAZ
parameter is set to true.
java.lang.Boolean publiclyAccessible
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
java.lang.Boolean autoMinorVersionUpgrade
java.lang.String licenseModel
Default: Same as source.
Valid values: license-included |
bring-your-own-license |
general-public-license
java.lang.String dBName
This parameter is not used for the MySQL engine.
java.lang.String engine
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values: MySQL | oracle-se1
| oracle-se | oracle-ee |
sqlserver-ee | sqlserver-se |
sqlserver-ex | sqlserver-web |
postgres
java.lang.Integer iops
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
java.lang.String optionGroupName
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String storageType
Valid values: standard | gp2 | io1
If you specify
io1, you must also include a value for the
Iops parameter.
Default: io1 if the
Iops parameter is specified; otherwise
standard
java.lang.String tdeCredentialArn
java.lang.String tdeCredentialPassword
java.lang.String dBSecurityGroupName
java.lang.String cIDRIP
CIDRIP is specified, EC2SecurityGroupName,
EC2SecurityGroupId and
EC2SecurityGroupOwnerId cannot be provided.java.lang.String eC2SecurityGroupName
EC2SecurityGroupId must be provided.
Otherwise, EC2SecurityGroupOwnerId and either
EC2SecurityGroupName or EC2SecurityGroupId
must be provided.java.lang.String eC2SecurityGroupId
EC2SecurityGroupId must be provided.
Otherwise, EC2SecurityGroupOwnerId and either
EC2SecurityGroupName or EC2SecurityGroupId
must be provided.java.lang.String eC2SecurityGroupOwnerId
EC2SecurityGroupName parameter. The AWS
Access Key ID is not an acceptable value. For VPC DB security groups,
EC2SecurityGroupId must be provided. Otherwise,
EC2SecurityGroupOwnerId and either EC2SecurityGroupName
or EC2SecurityGroupId must be provided.java.lang.String subnetIdentifier
AvailabilityZone subnetAvailabilityZone
This data type is used as an element in the following data type:
java.lang.String subnetStatus
java.lang.String key
java.lang.String value
java.lang.String clusterSecurityGroupName
java.lang.String cIDRIP
java.lang.String eC2SecurityGroupName
java.lang.String eC2SecurityGroupOwnerId
Example: 111122223333
java.lang.String snapshotIdentifier
java.lang.String snapshotClusterIdentifier
java.lang.String accountWithRestoreAccess
java.lang.String clusterIdentifier
java.lang.String nodeType
java.lang.String clusterStatus
available, creating, deleting,
rebooting, renaming, and
resizing.java.lang.String modifyStatus
java.lang.String masterUsername
java.lang.String dBName
Endpoint endpoint
java.util.Date clusterCreateTime
java.lang.Integer automatedSnapshotRetentionPeriod
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterSecurityGroups
ClusterSecurityGroup.Name and
ClusterSecurityGroup.Status subelements. Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterParameterGroups
java.lang.String clusterSubnetGroupName
java.lang.String vpcId
java.lang.String availabilityZone
java.lang.String preferredMaintenanceWindow
PendingModifiedValues pendingModifiedValues
java.lang.String clusterVersion
java.lang.Boolean allowVersionUpgrade
true, major version upgrades will be applied
automatically to the cluster during the maintenance window.java.lang.Integer numberOfNodes
java.lang.Boolean publiclyAccessible
true, the cluster can be accessed from a public
network.java.lang.Boolean encrypted
true, data in the cluster is encrypted at rest.RestoreStatus restoreStatus
HsmStatus hsmStatus
Values: active, applying
ClusterSnapshotCopyStatus clusterSnapshotCopyStatus
java.lang.String clusterPublicKey
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterNodes
ElasticIpStatus elasticIpStatus
java.lang.String clusterRevisionNumber
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String kmsKeyId
java.lang.String nodeRole
java.lang.String privateIPAddress
java.lang.String publicIPAddress
java.lang.String parameterGroupName
java.lang.String parameterGroupFamily
java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String clusterSecurityGroupName
java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> eC2SecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> iPRanges
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String destinationRegion
java.lang.Long retentionPeriod
java.lang.String clusterSubnetGroupName
java.lang.String description
java.lang.String vpcId
java.lang.String subnetGroupStatus
Complete, Incomplete and
Invalid.com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String clusterVersion
java.lang.String clusterParameterGroupFamily
java.lang.String description
java.lang.String sourceSnapshotIdentifier
Constraints:
available.java.lang.String sourceSnapshotClusterIdentifier
Constraints:
java.lang.String targetSnapshotIdentifier
Constraints:
java.lang.String parameterGroupName
Constraints:
java.lang.String parameterGroupFamily
To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0".
java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String dBName
To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.
Default: dev
Constraints:
java.lang.String clusterIdentifier
Constraints:
Example: myexamplecluster
java.lang.String clusterType
single-node, the NumberOfNodes parameter is
not required.multi-node, the
NumberOfNodes parameter is required. Valid
Values: multi-node | single-node
Default:
multi-node
java.lang.String nodeType
Valid Values: dw1.xlarge |
dw1.8xlarge | dw2.large |
dw2.8xlarge.
java.lang.String masterUsername
Constraints:
java.lang.String masterUserPassword
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterSecurityGroups
Default: The default cluster security group for Amazon Redshift.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Default: The default VPC security group is associated with the cluster.
java.lang.String clusterSubnetGroupName
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
java.lang.String availabilityZone
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example:
us-east-1d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
java.lang.String preferredMaintenanceWindow
Format:
ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
java.lang.String clusterParameterGroupName
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
java.lang.Integer automatedSnapshotRetentionPeriod
Default: 1
Constraints: Must be a value from 0 to 35.
java.lang.Integer port
The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.
Default:
5439
Valid Values: 1150-65535
java.lang.String clusterVersion
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
java.lang.Boolean allowVersionUpgrade
true, major version upgrades can be applied during the
maintenance window to the Amazon Redshift engine that is running on
the cluster. When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.
Default: true
java.lang.Integer numberOfNodes
multi-node. For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.
Default:
1
Constraints: Value must be at least 1 and no more than 100.
java.lang.Boolean publiclyAccessible
true, the cluster can be accessed from a public
network.java.lang.Boolean encrypted
true, the data in the cluster is encrypted at rest.
Default: false
java.lang.String hsmClientCertificateIdentifier
java.lang.String hsmConfigurationIdentifier
java.lang.String elasticIp
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String kmsKeyId
java.lang.String clusterSecurityGroupName
Constraints:
Example:
examplesecuritygroup
java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String snapshotIdentifier
Constraints:
Example:
my-snapshot-id
java.lang.String clusterIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String clusterSubnetGroupName
Constraints:
Example:
examplesubnetgroup
java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String subscriptionName
Constraints:
java.lang.String snsTopicArn
java.lang.String sourceType
Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIds
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
Values: Configuration, Management, Monitoring, Security
java.lang.String severity
Values: ERROR, INFO
java.lang.Boolean enabled
true to activate the
subscription, set to false to create the subscription but
not active it.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String hsmClientCertificateIdentifier
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String hsmConfigurationIdentifier
java.lang.String description
java.lang.String hsmIpAddress
java.lang.String hsmPartitionName
java.lang.String hsmPartitionPassword
java.lang.String hsmServerPublicCertificate
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String resourceName
arn:aws:redshift:us-east-1:123456789:cluster:t1.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
tag-key and
the corresponding value is passed in with the parameter
tag-value. The tag-key and
tag-value parameters are separated by a colon (:).
Separate multiple tags with a space. For example, --tags
"tag-key"="owner":"tag-value"="admin"
"tag-key"="environment":"tag-value"="test"
"tag-key"="version":"tag-value"="1.0".java.lang.String parameterGroupFamily
java.lang.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
java.lang.String clusterIdentifier
Constraints:
java.lang.Boolean skipFinalClusterSnapshot
true, a final
cluster snapshot is not created. If false, a final
cluster snapshot is created before the cluster is deleted. false.Default: false
java.lang.String finalClusterSnapshotIdentifier
false.
Constraints:
java.lang.String snapshotIdentifier
Constraints: Must be the name of an existing snapshot that is in
the available state.
java.lang.String snapshotClusterIdentifier
Constraints: Must be the name of valid cluster.
java.lang.String resourceName
arn:aws:redshift:us-east-1:123456789:cluster:t1.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
java.lang.String parameterGroupName
java.lang.Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
java.lang.String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner and environment. If
you specify both of these tag keys in the request, Amazon Redshift
returns a response with the parameter groups that have either or both
of these tag keys associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin and
test. If you specify both of these tag values in the
request, Amazon Redshift returns a response with the parameter groups
that have either or both of these tag values associated with them.java.lang.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterGroups
java.lang.String parameterGroupName
java.lang.String source
user to show
parameters that are different form the default. Similarly, specify
engine-default to show parameters that are the same as
the default parameter group. Default: All parameter types returned.
Valid Values: user | engine-default
java.lang.Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
java.lang.String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
java.lang.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.java.lang.String clusterSecurityGroupName
Example:
securitygroup1
java.lang.Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
java.lang.String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request. Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner and environment. If
you specify both of these tag keys in the request, Amazon Redshift
returns a response with the security groups that have either or both
of these tag keys associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin and
test. If you specify both of these tag values in the
request, Amazon Redshift returns a response with the security groups
that have either or both of these tag values associated with them.java.lang.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterSecurityGroups
java.lang.String clusterIdentifier
java.lang.String snapshotIdentifier
java.lang.String snapshotType
Valid Values:
automated | manual
java.util.Date startTime
Example: 2012-07-16T18:00:00Z
java.util.Date endTime
Example: 2012-07-16T18:00:00Z
java.lang.Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
java.lang.String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.java.lang.String ownerAccount
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner and environment. If you specify
both of these tag keys in the request, Amazon Redshift returns a
response with the snapshots that have either or both of these tag keys
associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin and test. If you
specify both of these tag values in the request, Amazon Redshift
returns a response with the snapshots that have either or both of
these tag values associated with them.java.lang.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshots
java.lang.String clusterIdentifier
The default is that all clusters defined for an account are returned.
java.lang.Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
java.lang.String marker
MaxRecords, AWS
returns a value in the Marker field of the response. You
can retrieve the next set of response records by providing the
returned marker value in the Marker parameter and
retrying the request. Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner and environment. If you specify both
of these tag keys in the request, Amazon Redshift returns a response
with the clusters that have either or both of these tag keys
associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin and test. If you specify
both of these tag values in the request, Amazon Redshift returns a
response with the clusters that have either or both of these tag
values associated with them.java.lang.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> clusters
java.lang.String clusterSubnetGroupName
java.lang.Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
java.lang.String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner and environment. If you specify
both of these tag keys in the request, Amazon Redshift returns a
response with the subnet groups that have either or both of these tag
keys associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin and test. If
you specify both of these tag values in the request, Amazon Redshift
returns a response with the subnet groups that have either or both of
these tag values associated with them.java.lang.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterSubnetGroups
java.lang.String clusterVersion
Example: 1.0
java.lang.String clusterParameterGroupFamily
Constraints:
java.lang.Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
java.lang.String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.java.lang.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterVersions
Version elements.java.lang.String parameterGroupFamily
java.lang.Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
java.lang.String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.java.lang.String sourceIdentifier
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
cluster.cluster-security-group.cluster-parameter-group.cluster-snapshot.java.lang.String sourceType
Constraints:
If SourceType is supplied, SourceIdentifier must also be provided.
cluster when SourceIdentifier is a
cluster identifier.cluster-security-group when SourceIdentifier is a
cluster security group name.cluster-parameter-group when SourceIdentifier is a
cluster parameter group name.cluster-snapshot when SourceIdentifier is a
cluster snapshot identifier.
Constraints:
Allowed Values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot
java.util.Date startTime
Example: 2009-07-08T18:00Z
java.util.Date endTime
Example: 2009-07-08T18:00Z
java.lang.Integer duration
Default: 60
java.lang.Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
java.lang.String marker
MaxRecords, AWS
returns a value in the Marker field of the response. You
can retrieve the next set of response records by providing the
returned marker value in the Marker parameter and
retrying the request.java.lang.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> events
java.lang.String subscriptionName
java.lang.Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
java.lang.String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.java.lang.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> eventSubscriptionsList
java.lang.String hsmClientCertificateIdentifier
java.lang.Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
java.lang.String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner and environment. If
you specify both of these tag keys in the request, Amazon Redshift
returns a response with the HSM client certificates that have either
or both of these tag keys associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin and
test. If you specify both of these tag values in the
request, Amazon Redshift returns a response with the HSM client
certificates that have either or both of these tag values associated
with them.java.lang.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> hsmClientCertificates
java.lang.String hsmConfigurationIdentifier
java.lang.Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
java.lang.String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner and environment. If you
specify both of these tag keys in the request, Amazon Redshift returns
a response with the HSM configurations that have either or both of
these tag keys associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin and test. If
you specify both of these tag values in the request, Amazon Redshift
returns a response with the HSM configurations that have either or
both of these tag values associated with them.java.lang.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> hsmConfigurations
java.lang.Boolean loggingEnabled
true if logging is on, false if logging is
off.java.lang.String bucketName
java.lang.String s3KeyPrefix
java.util.Date lastSuccessfulDeliveryTime
java.util.Date lastFailureTime
java.lang.String lastFailureMessage
java.lang.String clusterVersion
Default: All versions.
Constraints: Must be one of the version returned from DescribeClusterVersions.
java.lang.String nodeType
java.lang.Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
java.lang.String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> orderableClusterOptions
java.lang.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.java.lang.String reservedNodeOfferingId
java.lang.Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
java.lang.String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.java.lang.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedNodeOfferings
java.lang.String reservedNodeId
java.lang.Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
java.lang.String marker
MaxRecords, AWS returns a value in the
Marker field of the response. You can retrieve the next
set of response records by providing the returned marker value in the
Marker parameter and retrying the request.java.lang.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedNodes
java.lang.String targetNodeType
java.lang.Integer targetNumberOfNodes
java.lang.String targetClusterType
Valid
Values: multi-node | single-node
java.lang.String status
Valid Values: NONE
| IN_PROGRESS | FAILED |
SUCCEEDED
com.amazonaws.internal.ListWithAutoConstructFlag<T> importTablesCompleted
Valid Values: List of table names.
com.amazonaws.internal.ListWithAutoConstructFlag<T> importTablesInProgress
Valid Values: List of table names.
com.amazonaws.internal.ListWithAutoConstructFlag<T> importTablesNotStarted
Valid Values: List of table names
java.lang.Double avgResizeRateInMegaBytesPerSecond
java.lang.Long totalResizeDataInMegaBytes
java.lang.Long progressInMegaBytes
java.lang.Long elapsedTimeInSeconds
java.lang.Long estimatedTimeToCompletionInSeconds
java.lang.String resourceName
arn:aws:redshift:us-east-1:123456789:cluster:t1.java.lang.String resourceType
For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
java.lang.Integer maxRecords
MaxRecords value, a value is returned in a
marker field of the response. You can retrieve the next
set of records by retrying the command with the returned
marker value.java.lang.String marker
marker parameter and retrying the
command. If the marker field is empty, all response
records have been retrieved for the request.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
owner and environment. If you specify both
of these tag keys in the request, Amazon Redshift returns a response
with all resources that have either or both of these tag keys
associated with them.com.amazonaws.internal.ListWithAutoConstructFlag<T> tagValues
admin and test. If you specify both of these
tag values in the request, Amazon Redshift returns a response with all
resources that have either or both of these tag values associated with
them.com.amazonaws.internal.ListWithAutoConstructFlag<T> taggedResources
java.lang.String marker
Marker parameter and retrying the
command. If the Marker field is empty, all response
records have been retrieved for the request.java.lang.Boolean loggingEnabled
true if logging is on, false if logging is
off.java.lang.String bucketName
java.lang.String s3KeyPrefix
java.util.Date lastSuccessfulDeliveryTime
java.util.Date lastFailureTime
java.lang.String lastFailureMessage
java.lang.String status
java.lang.String eC2SecurityGroupName
java.lang.String eC2SecurityGroupOwnerId
EC2SecurityGroupName field.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String clusterIdentifier
Example: examplecluster
java.lang.String bucketName
Constraints:
java.lang.String s3KeyPrefix
Constraints:
java.lang.Boolean loggingEnabled
true if logging is on, false if logging is
off.java.lang.String bucketName
java.lang.String s3KeyPrefix
java.util.Date lastSuccessfulDeliveryTime
java.util.Date lastFailureTime
java.lang.String lastFailureMessage
java.lang.String clusterIdentifier
Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.
java.lang.String destinationRegion
Constraints: Must be the name of a valid region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
java.lang.Integer retentionPeriod
Default: 7.
Constraints: Must be at least 1 and no more than 35.
java.lang.String sourceIdentifier
java.lang.String sourceType
Constraints:
Allowed Values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot
java.lang.String message
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
java.lang.String severity
Values: ERROR, INFO
java.util.Date date
java.lang.String eventId
java.lang.String eventId
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
java.lang.String eventDescription
java.lang.String severity
Values: ERROR, INFO
java.lang.String customerAwsId
java.lang.String custSubscriptionId
java.lang.String snsTopicArn
java.lang.String status
Constraints:
java.util.Date subscriptionCreationTime
java.lang.String sourceType
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIdsList
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategoriesList
Values: Configuration, Management, Monitoring, Security
java.lang.String severity
Values: ERROR, INFO
java.lang.Boolean enabled
true indicates the subscription is enabled.com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String hsmClientCertificateIdentifier
java.lang.String hsmClientCertificatePublicKey
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String hsmConfigurationIdentifier
java.lang.String description
java.lang.String hsmIpAddress
java.lang.String hsmPartitionName
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String hsmClientCertificateIdentifier
java.lang.String hsmConfigurationIdentifier
java.lang.String status
Values: active, applying
java.lang.String parameterGroupName
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
java.lang.String parameterGroupName
java.lang.String parameterGroupStatus
java.lang.String clusterIdentifier
Example:
examplecluster
java.lang.String clusterType
When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.
Valid Values: multi-node | single-node
java.lang.String nodeType
When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.
Valid Values: dw1.xlarge |
dw1.8xlarge | dw2.large |
dw2.8xlarge.
java.lang.Integer numberOfNodes
When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.
Valid Values: Integer greater than
0.
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterSecurityGroups
Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
java.lang.String masterUserPassword
MasterUserPassword element exists in the
PendingModifiedValues element of the operation response.
Default: Uses existing setting.
Constraints:
java.lang.String clusterParameterGroupName
Default: Uses existing setting.
Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.
java.lang.Integer automatedSnapshotRetentionPeriod
If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.
Default: Uses existing setting.
Constraints: Must be a value from 0 to 35.
java.lang.String preferredMaintenanceWindow
This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.
Default: Uses existing setting.
Format:
ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes.
java.lang.String clusterVersion
For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Example: 1.0
java.lang.Boolean allowVersionUpgrade
true, major version upgrades will be applied
automatically to the cluster during the maintenance window.
Default: false
java.lang.String hsmClientCertificateIdentifier
java.lang.String hsmConfigurationIdentifier
java.lang.String newClusterIdentifier
Constraints:
Example: examplecluster
java.lang.String clusterSubnetGroupName
java.lang.String description
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
java.lang.String subscriptionName
java.lang.String snsTopicArn
java.lang.String sourceType
Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIds
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
Values: Configuration, Management, Monitoring, Security
java.lang.String severity
Values: ERROR, INFO
java.lang.Boolean enabled
true indicates the subscription is enabledjava.lang.String clusterIdentifier
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
java.lang.Integer retentionPeriod
If you decrease the retention period for automated snapshots that are copied to a destination region, Amazon Redshift will delete any existing automated snapshots that were copied to the destination region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35.
java.lang.String clusterVersion
java.lang.String clusterType
multi-node.java.lang.String nodeType
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
java.lang.String parameterName
java.lang.String parameterValue
java.lang.String description
java.lang.String source
java.lang.String dataType
java.lang.String allowedValues
java.lang.Boolean isModifiable
true, the parameter can be modified. Some parameters
have security or operational implications that prevent them from being
changed.java.lang.String minimumEngineVersion
java.lang.String masterUserPassword
java.lang.String nodeType
java.lang.Integer numberOfNodes
java.lang.String clusterType
java.lang.String clusterVersion
java.lang.Integer automatedSnapshotRetentionPeriod
java.lang.String clusterIdentifier
java.lang.String reservedNodeId
java.lang.String reservedNodeOfferingId
java.lang.String nodeType
java.util.Date startTime
java.lang.Integer duration
java.lang.Double fixedPrice
java.lang.Double usagePrice
java.lang.String currencyCode
java.lang.Integer nodeCount
java.lang.String state
Possible Values:
java.lang.String offeringType
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
java.lang.String reservedNodeOfferingId
java.lang.String nodeType
java.lang.Integer duration
java.lang.Double fixedPrice
java.lang.Double usagePrice
java.lang.String currencyCode
java.lang.String offeringType
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
java.lang.String parameterGroupName
java.lang.Boolean resetAllParameters
true, all parameters in the specified parameter group
will be reset to their default values. Default: true
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Constraints: A maximum of 20 parameters can be reset in a single request.
java.lang.String parameterGroupName
java.lang.String parameterGroupStatus
java.lang.String clusterIdentifier
Constraints:
java.lang.String snapshotIdentifier
Example:
my-snapshot-id
java.lang.String snapshotClusterIdentifier
java.lang.Integer port
Default: The same port as the original cluster.
Constraints: Must be between
1115 and 65535.
java.lang.String availabilityZone
Default: A random, system-chosen Availability Zone.
Example:
us-east-1a
java.lang.Boolean allowVersionUpgrade
true, major version upgrades can be applied during the
maintenance window to the Amazon Redshift engine that is running on
the cluster. Default: true
java.lang.String clusterSubnetGroupName
A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.
java.lang.Boolean publiclyAccessible
true, the cluster can be accessed from a public
network.java.lang.String ownerAccount
java.lang.String hsmClientCertificateIdentifier
java.lang.String hsmConfigurationIdentifier
java.lang.String elasticIp
java.lang.String clusterParameterGroupName
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.
Constraints:
com.amazonaws.internal.ListWithAutoConstructFlag<T> clusterSecurityGroups
Default: The default cluster security group for Amazon Redshift.
Cluster security groups only apply to clusters outside of VPCs.
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
Default: The default VPC security group is associated with the cluster.
VPC security groups only apply to clusters in VPCs.
java.lang.String preferredMaintenanceWindow
Format:
ddd:hh24:mi-ddd:hh24:mi
Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
java.lang.Integer automatedSnapshotRetentionPeriod
Default: The value selected for the cluster from which the snapshot was taken.
Constraints: Must be a value from 0 to 35.
java.lang.String kmsKeyId
java.lang.String status
java.lang.Double currentRestoreRateInMegaBytesPerSecond
java.lang.Long snapshotSizeInMegaBytes
java.lang.Long progressInMegaBytes
java.lang.Long elapsedTimeInSeconds
java.lang.Long estimatedTimeToCompletionInSeconds
java.lang.String clusterSecurityGroupName
java.lang.String cIDRIP
CIDRIP is specified, EC2SecurityGroupName
and EC2SecurityGroupOwnerId cannot be provided.java.lang.String eC2SecurityGroupName
EC2SecurityGroupName is specified,
EC2SecurityGroupOwnerId must also be provided and
CIDRIP cannot be provided.java.lang.String eC2SecurityGroupOwnerId
EC2SecurityGroupName parameter. The AWS access key ID
is not an acceptable value. If EC2SecurityGroupOwnerId is
specified, EC2SecurityGroupName must also be provided.
and CIDRIP cannot be provided. Example:
111122223333
java.lang.String snapshotIdentifier
java.lang.String snapshotClusterIdentifier
java.lang.String accountWithRestoreAccess
java.lang.String snapshotIdentifier
java.lang.String clusterIdentifier
java.util.Date snapshotCreateTime
java.lang.String status
java.lang.Integer port
java.lang.String availabilityZone
java.util.Date clusterCreateTime
java.lang.String masterUsername
java.lang.String clusterVersion
java.lang.String snapshotType
java.lang.String nodeType
java.lang.Integer numberOfNodes
java.lang.String dBName
java.lang.String vpcId
java.lang.Boolean encrypted
true, the data in the snapshot is encrypted at rest.java.lang.String kmsKeyId
java.lang.Boolean encryptedWithHSM
true indicates that
the data is encrypted using HSM keys.com.amazonaws.internal.ListWithAutoConstructFlag<T> accountsWithRestoreAccess
null if no accounts are authorized.
Visible only to the snapshot owner.java.lang.String ownerAccount
java.lang.Double totalBackupSizeInMegaBytes
java.lang.Double actualIncrementalBackupSizeInMegaBytes
java.lang.Double backupProgressInMegaBytes
java.lang.Double currentBackupRateInMegaBytesPerSecond
0 for a completed backup.java.lang.Long estimatedSecondsToCompletion
0 for a completed backup.java.lang.Long elapsedTimeInSeconds
java.lang.String sourceRegion
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
java.lang.String subnetIdentifier
AvailabilityZone subnetAvailabilityZone
java.lang.String subnetStatus
Tag tag
java.lang.String resourceName
arn:aws:redshift:us-east-1:123456789:cluster:t1.java.lang.String resourceType
For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
java.lang.String hostedZoneId
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide.
Constraints:
Length: 0 - 32
java.lang.String dNSName
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide.
Constraints:
Length: 0 - 1024
java.lang.Boolean evaluateTargetHealth
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide.
java.lang.String hostedZoneId
Note that you cannot associate a VPC with a hosted zone that doesn't have an existing VPC association.
Constraints:
Length: 0 - 32
VPC vPC
java.lang.String comment
AssociateVPCWithHostedZoneRequest.ChangeInfo changeInfo
AssociateVPCWithHostedZoneRequest.java.lang.String action
Valid values: CREATE |
DELETE | UPSERT
Constraints:
Allowed Values: CREATE, DELETE, UPSERT
ResourceRecordSet resourceRecordSet
java.lang.String comment
Constraints:
Length: 0 - 256
com.amazonaws.internal.ListWithAutoConstructFlag<T> changes
Change element for each
resource record set that you want to create or delete.
Constraints:
Length: 1 -
java.lang.String id
Constraints:
Length: 0 - 32
java.lang.String status
PENDING indicates that
this request has not yet been applied to all Amazon Route 53 DNS
servers. Valid Values: PENDING | INSYNC
Constraints:
Allowed Values: PENDING, INSYNC
java.util.Date submittedAt
YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601
standard (for example, 2009-11-19T19:37:58Z). The Z after
the time indicates that the time is listed in Coordinated Universal
Time (UTC), which is synonymous with Greenwich Mean Time in this
context.java.lang.String comment
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
Constraints:
Length: 0 - 256
java.lang.String hostedZoneId
Constraints:
Length: 0 - 32
ChangeBatch changeBatch
Changes element.ChangeInfo changeInfo
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
java.lang.String resourceType
healthcheck.
Constraints:
Allowed Values: healthcheck
java.lang.String resourceId
Constraints:
Length: 0 - 64
com.amazonaws.internal.ListWithAutoConstructFlag<T> addTags
Tag elements. Each
Tag element identifies a tag that you want to add or
update for the specified resource.
Constraints:
Length: 1 - 10
com.amazonaws.internal.ListWithAutoConstructFlag<T> removeTagKeys
Tag keys that you want to remove from the
specified resource.
Constraints:
Length: 1 - 10
java.lang.String callerReference
CreateHealthCheck requests to be retried without the risk
of executing the operation twice. You must use a unique
CallerReference string every time you create a health
check. CallerReference can be any unique string; you
might choose to use a string that identifies your project. Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
Constraints:
Length: 1 - 64
HealthCheckConfig healthCheckConfig
HealthCheck healthCheck
java.lang.String location
Constraints:
Length: 0 - 1024
java.lang.String name
This is the
name you have registered with your DNS registrar. You should ask your
registrar to change the authoritative name servers for your domain to
the set of NameServers elements returned in
DelegationSet.
Constraints:
Length: 0 - 1024
VPC vPC
java.lang.String callerReference
CreateHostedZone requests to be retried without the risk
of executing the operation twice. You must use a unique
CallerReference string every time you create a hosted
zone. CallerReference can be any unique string; you might
choose to use a string that identifies your project, such as
DNSMigration_01. Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
Constraints:
Length: 1 - 128
HostedZoneConfig hostedZoneConfig
java.lang.String delegationSetId
Constraints:
Length: 0 - 32
HostedZone hostedZone
ChangeInfo changeInfo
DelegationSet delegationSet
VPC vPC
java.lang.String location
Constraints:
Length: 0 - 1024
java.lang.String callerReference
CreateReusableDelegationSet requests to be retried
without the risk of executing the operation twice. You must use a
unique CallerReference string every time you create a
reusable delegation set. CallerReference can be any
unique string; you might choose to use a string that identifies your
project, such as DNSMigration_01. Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
Constraints:
Length: 1 - 128
java.lang.String hostedZoneId
Constraints:
Length: 0 - 32
DelegationSet delegationSet
java.lang.String location
Constraints:
Length: 0 - 1024
java.lang.String id
java.lang.String callerReference
com.amazonaws.internal.ListWithAutoConstructFlag<T> nameServers
NameServer that is
assigned to your hosted zone.
Constraints:
Length: 1 -
ChangeInfo changeInfo
java.lang.String hostedZoneId
Note that you cannot disassociate the last VPC from a hosted zone.
Constraints:
Length: 0 - 32
VPC vPC
java.lang.String comment
DisassociateVPCFromHostedZoneRequest.ChangeInfo changeInfo
DisassociateVPCFromHostedZoneRequest.java.lang.String continentCode
Valid values: AF |
AN | AS | EU | OC
| NA | SA
Constraint: Specifying
ContinentCode with either CountryCode or
SubdivisionCode returns an InvalidInput error.
Constraints:
Length: 2 - 2
java.lang.String countryCode
The default geo location uses a * for
the country code. All other country codes follow the ISO 3166
two-character code.
Constraints:
Length: 1 - 2
java.lang.String subdivisionCode
Constraint: Specifying SubdivisionCode without
CountryCode returns an InvalidInput error.
Constraints:
Length: 1 - 3
java.lang.String continentCode
Constraints:
Length: 2 - 2
java.lang.String continentName
ContinentCode is also present.
Constraints:
Length: 1 - 32
java.lang.String countryCode
The default geo location uses a * for
the country code. All other country codes follow the ISO 3166
two-character code.
Constraints:
Length: 1 - 2
java.lang.String countryName
CountryCode is also present.
Constraints:
Length: 1 - 64
java.lang.String subdivisionCode
Constraints:
Length: 1 - 3
java.lang.String subdivisionName
SubdivisionCode is also present.
Constraints:
Length: 1 - 64
ChangeInfo changeInfo
java.lang.String continentCode
Valid values: AF |
AN | AS | EU | OC
| NA | SA
Constraint: Specifying
ContinentCode with either CountryCode or
SubdivisionCode returns an InvalidInput error.
Constraints:
Length: 2 - 2
java.lang.String countryCode
The default geo location uses a * for
the country code. All other country codes follow the ISO 3166
two-character code.
Constraints:
Length: 1 - 2
java.lang.String subdivisionCode
Constraint: Specifying SubdivisionCode without
CountryCode returns an InvalidInput error.
Constraints:
Length: 1 - 3
GeoLocationDetails geoLocationDetails
HealthCheck healthCheck
HostedZone hostedZone
DelegationSet delegationSet
com.amazonaws.internal.ListWithAutoConstructFlag<T> vPCs
Constraints:
Length: 1 -
DelegationSet delegationSet
java.lang.String id
Constraints:
Length: 0 - 64
java.lang.String callerReference
Constraints:
Length: 1 - 64
HealthCheckConfig healthCheckConfig
java.lang.Long healthCheckVersion
UpdateHealthCheck to prevent overwriting
another change to the health check.
Constraints:
Range: 1 -
java.lang.String iPAddress
Constraints:
Length: 0 - 15
Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
java.lang.Integer port
Constraints:
Range: 1 - 65535
java.lang.String type
Constraints:
Allowed Values: HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP
java.lang.String resourcePath
Constraints:
Length: 0 - 255
java.lang.String fullyQualifiedDomainName
Constraints:
Length: 0 - 255
java.lang.String searchString
Constraints:
Length: 0 - 255
java.lang.Integer requestInterval
Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
Constraints:
Range: 10 - 30
java.lang.Integer failureThreshold
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Constraints:
Range: 1 - 10
java.lang.String iPAddress
Constraints:
Length: 0 - 15
Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
StatusReport statusReport
java.lang.String id
Constraints:
Length: 0 - 32
java.lang.String name
This is the
name you have registered with your DNS registrar. You should ask your
registrar to change the authoritative name servers for your domain to
the set of NameServers elements returned in
DelegationSet.
Constraints:
Length: 0 - 1024
java.lang.String callerReference
Constraints:
Length: 1 - 128
HostedZoneConfig config
Comment element.java.lang.Long resourceRecordSetCount
java.lang.String comment
HostedZoneConfig and
Comment elements from the XML document.
Constraints:
Length: 0 - 256
java.lang.Boolean privateZone
java.lang.String startContinentCode
ListGeoLocations request to
list. For non-continent geo locations, this should be null. Valid
values: AF | AN | AS |
EU | OC | NA | SA
Constraint: Specifying ContinentCode with either
CountryCode or SubdivisionCode returns an
InvalidInput error.
Constraints:
Length: 2 - 2
java.lang.String startCountryCode
ListGeoLocations request to list.
The default geo location uses a * for the country
code. All other country codes follow the ISO 3166 two-character code.
Constraints:
Length: 1 - 2
java.lang.String startSubdivisionCode
ListGeoLocations request to
list. Constraint: Specifying SubdivisionCode without
CountryCode returns an InvalidInput error.
Constraints:
Length: 1 - 3
java.lang.String maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> geoLocationDetailsList
java.lang.Boolean isTruncated
Valid
Values: true | false
java.lang.String nextContinentCode
Constraints:
Length: 2 - 2
java.lang.String nextCountryCode
Constraints:
Length: 1 - 2
java.lang.String nextSubdivisionCode
Constraints:
Length: 1 - 3
java.lang.String maxItems
MaxItems is 100.java.lang.String marker
NextMarker from the last
response in the marker parameter to get the next page of
results.
Constraints:
Length: 0 - 64
java.lang.String maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> healthChecks
java.lang.String marker
NextMarker from the last
response in the marker parameter to get the next page of
results.
Constraints:
Length: 0 - 64
java.lang.Boolean isTruncated
Marker element.
Valid Values: true | false
java.lang.String nextMarker
true, make
another request to ListHealthChecks and include the value
of the NextMarker element in the Marker
element to get the next page of results.
Constraints:
Length: 0 - 64
java.lang.String maxItems
MaxItems, the value of
ListHealthChecksResponse$IsTruncated in the response is
true. Call ListHealthChecks again and
specify the value of ListHealthChecksResponse$NextMarker in the
ListHostedZonesRequest$Marker element to get the next page of
results.java.lang.String marker
NextMarker from the last
response in the marker parameter to get the next page of
results.
Constraints:
Length: 0 - 64
java.lang.String maxItems
java.lang.String delegationSetId
com.amazonaws.internal.ListWithAutoConstructFlag<T> hostedZones
java.lang.String marker
NextMarker from the last
response in the marker parameter to get the next page of
results.
Constraints:
Length: 0 - 64
java.lang.Boolean isTruncated
Marker element.
Valid Values: true | false
java.lang.String nextMarker
true, make
another request to ListHostedZones and include the value
of the NextMarker element in the Marker
element to get the next page of results.
Constraints:
Length: 0 - 64
java.lang.String maxItems
MaxItems, the value of
ListHostedZonesResponse$IsTruncated in the response is
true. Call ListHostedZones again and specify
the value of ListHostedZonesResponse$NextMarker in the
ListHostedZonesRequest$Marker element to get the next page of
results.java.lang.String hostedZoneId
Constraints:
Length: 0 - 32
java.lang.String startRecordName
ListResourceRecordSets request to list.
Constraints:
Length: 0 - 1024
java.lang.String startRecordType
Valid values: A | AAAA |
CNAME | MX | NS |
PTR | SOA | SPF |
SRV | TXT
Values for Weighted Resource
Record Sets: A | AAAA | CNAME |
TXT
Values for Regional Resource Record Sets:
A | AAAA | CNAME |
TXT
Values for Alias Resource Record Sets:
A | AAAA
Constraint: Specifying
type without specifying name returns an
InvalidInput error.
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
java.lang.String startRecordIdentifier
ListResourceRecordSetsResponse$NextRecordIdentifier from
the previous response to get the next resource record set that has the
current DNS name and type.
Constraints:
Length: 1 - 128
java.lang.String maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceRecordSets
java.lang.Boolean isTruncated
Valid
Values: true | false
java.lang.String nextRecordName
Constraints:
Length: 0 - 1024
java.lang.String nextRecordType
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
java.lang.String nextRecordIdentifier
SetIdentifier
for the next resource record set that has the current DNS name and
type.
Constraints:
Length: 1 - 128
java.lang.String maxItems
MaxItems is 100.java.lang.String marker
NextMarker from the last
response in the marker parameter to get the next page of
results.
Constraints:
Length: 0 - 64
java.lang.String maxItems
com.amazonaws.internal.ListWithAutoConstructFlag<T> delegationSets
java.lang.String marker
NextMarker from the last
response in the marker parameter to get the next page of
results.
Constraints:
Length: 0 - 64
java.lang.Boolean isTruncated
Marker
element. Valid Values: true | false
java.lang.String nextMarker
true, make another request to
ListReusableDelegationSets and include the value of the
NextMarker element in the Marker element to
get the next page of results.
Constraints:
Length: 0 - 64
java.lang.String maxItems
MaxItems, the value of
ListReusablDelegationSetsResponse$IsTruncated in the response
is true. Call ListReusableDelegationSets
again and specify the value of
ListReusableDelegationSetsResponse$NextMarker in the
ListReusableDelegationSetsRequest$Marker element to get the
next page of results.java.lang.String resourceType
healthcheck.
Constraints:
Allowed Values: healthcheck
java.lang.String resourceId
Constraints:
Length: 0 - 64
ResourceTagSet resourceTagSet
ResourceTagSet containing tags associated with the
specified resource.java.lang.String resourceType
healthcheck.
Constraints:
Allowed Values: healthcheck
com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceIds
Constraints:
Length: 1 - 10
java.lang.String name
Constraints:
Length: 0 - 1024
java.lang.String type
Constraints:
Allowed Values: SOA, A, TXT, NS, CNAME, MX, PTR, SRV, SPF, AAAA
java.lang.String setIdentifier
Constraints:
Length: 1 - 128
java.lang.Long weight
Constraints:
Range: 0 - 255
java.lang.String region
Constraints:
Length: 1 - 64
Allowed Values: us-east-1, us-west-1, us-west-2, eu-west-1, eu-central-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1, cn-north-1
GeoLocation geoLocation
java.lang.String failover
Valid values: PRIMARY |
SECONDARY
Constraints:
Allowed Values: PRIMARY, SECONDARY
java.lang.Long tTL
Constraints:
Range: 0 - 2147483647
com.amazonaws.internal.ListWithAutoConstructFlag<T> resourceRecords
Constraints:
Length: 1 -
AliasTarget aliasTarget
java.lang.String healthCheckId
Constraints:
Length: 0 - 64
java.lang.String resourceType
healthcheck.
Constraints:
Allowed Values: healthcheck
java.lang.String resourceId
Constraints:
Length: 0 - 64
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
Constraints:
Length: 1 - 10
java.lang.String status
java.util.Date checkedTime
YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601
standard (for example, 2009-11-19T19:37:58Z). The Z after
the time indicates that the time is listed in Coordinated Universal
Time (UTC), which is synonymous with Greenwich Mean Time in this
context.java.lang.String healthCheckId
Constraints:
Length: 0 - 64
java.lang.Long healthCheckVersion
HealthCheckVersion lets you prevent overwriting
another change to the health check.
Constraints:
Range: 1 -
java.lang.String iPAddress
Specify this value only if you want to change it.
Constraints:
Length: 0 - 15
Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
java.lang.Integer port
Specify this value only if you want to change it.
Constraints:
Range: 1 - 65535
java.lang.String resourcePath
Specify this value only if you want to change it.
Constraints:
Length: 0 - 255
java.lang.String fullyQualifiedDomainName
Specify this value only if you want to change it.
Constraints:
Length: 0 - 255
java.lang.String searchString
Type is HTTP_STR_MATCH or
HTTP_STR_MATCH, the string that you want Route 53 to
search for in the response body from the specified resource. If the
string appears in the response body, Route 53 considers the resource
healthy. Specify this value only if you want to change it.
Constraints:
Length: 0 - 255
java.lang.Integer failureThreshold
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
Constraints:
Range: 1 - 10
HealthCheck healthCheck
HostedZone hostedZone
java.lang.String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
java.lang.String idnLangCode
Constraints:
Length: 0 - 3
java.lang.String availability
You
can only register domains designated as AVAILABLE.
Type: String
Valid values:
AVAILABLE ??? The domain name is available.AVAILABLE_RESERVED ??? The domain name is reserved
under specific conditions.AVAILABLE_PREORDER
??? The domain name is available and can be preordered.UNAVAILABLE ??? The domain name is not
available.UNAVAILABLE_PREMIUM ??? The domain
name is not available.UNAVAILABLE_RESTRICTED
??? The domain name is forbidden.RESERVED ???
The domain name has been reserved for another person or
organization.
Constraints:
Allowed Values: AVAILABLE, AVAILABLE_RESERVED, AVAILABLE_PREORDER, UNAVAILABLE, UNAVAILABLE_PREMIUM, UNAVAILABLE_RESTRICTED, RESERVED
java.lang.String firstName
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents:
RegistrantContact, AdminContact,
TechContact
Required: Yes
Constraints:
Length: 0 - 255
java.lang.String lastName
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents: RegistrantContact,
AdminContact, TechContact
Required: Yes
Constraints:
Length: 0 - 255
java.lang.String contactType
PERSON, you must enter an organization name, and you
can't enable privacy protection for the contact. Type: String
Default: None
Constraints: Maximum 255 characters.
Valid
values: PERSON | COMPANY |
ASSOCIATION | PUBLIC_BODY
Parents:
RegistrantContact, AdminContact,
TechContact
Required: Yes
Constraints:
Allowed Values: PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
java.lang.String organizationName
PERSON. Type: String
Default: None
Constraints:
Maximum 255 characters. Contact type must not be PERSON.
Parents: RegistrantContact, AdminContact,
TechContact
Required: No
Constraints:
Length: 0 - 255
java.lang.String addressLine1
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents:
RegistrantContact, AdminContact,
TechContact
Required: Yes
Constraints:
Length: 0 - 255
java.lang.String addressLine2
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents:
RegistrantContact, AdminContact,
TechContact
Required: No
Constraints:
Length: 0 - 255
java.lang.String city
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents:
RegistrantContact, AdminContact,
TechContact
Required: Yes
Constraints:
Length: 0 - 255
java.lang.String state
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents:
RegistrantContact, AdminContact,
TechContact
Required: No
Constraints:
Length: 0 - 255
java.lang.String countryCode
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents:
RegistrantContact, AdminContact,
TechContact
Required: Yes
Constraints:
Allowed Values: AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GH, GI, GL, GM, GN, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, ID, IE, IL, IM, IN, IQ, IR, IS, IT, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PT, PW, PY, QA, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
java.lang.String zipCode
Type: String
Default: None
Constraints: Maximum 255 characters.
Parents:
RegistrantContact, AdminContact,
TechContact
Required: No
Constraints:
Length: 0 - 255
java.lang.String phoneNumber
Type: String
Default: None
Constraints: Phone number must be specified in the format
"+[country dialing code].[number including any area code>]". For
example, a US phone number might appear as
"+1.1234567890".
Parents:
RegistrantContact, AdminContact,
TechContact
Required: Yes
Constraints:
Length: 0 - 30
java.lang.String email
Type: String
Default: None
Constraints: Maximum 254 characters.
Parents:
RegistrantContact, AdminContact,
TechContact
Required: Yes
Constraints:
Length: 0 - 254
java.lang.String fax
Type: String
Default: None
Constraints: Phone number must be specified in the format
"+[country dialing code].[number including any area code]". For
example, a US phone number might appear as
"+1.1234567890".
Parents:
RegistrantContact, AdminContact,
TechContact
Required: No
Constraints:
Length: 0 - 30
com.amazonaws.internal.ListWithAutoConstructFlag<T> extraParams
Type: Complex
Default: None
Parents:
RegistrantContact, AdminContact,
TechContact
Children: Name,
Value
Required: No
java.lang.String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
java.lang.String domainName
Type: String
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
java.lang.Boolean autoRenew
Type: Boolean
Valid values: True |
False
java.lang.Boolean transferLock
Type: Boolean
Valid values: True |
False
java.util.Date expiry
Type: Long
java.lang.String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
java.lang.String name
Type: String
Default: None
Valid values:
DUNS_NUMBER | BRAND_NUMBER |
BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD
| BIRTH_COUNTRY | BIRTH_CITY |
DOCUMENT_NUMBER | AU_ID_NUMBER |
AU_ID_TYPE | CA_LEGAL_TYPE |
FI_BUSINESS_NUMBER | FI_ID_NUMBER |
IT_PIN | RU_PASSPORT_DATA |
SE_ID_NUMBER | SG_ID_NUMBER |
VAT_NUMBER
Parent: ExtraParams
Required: Yes
Constraints:
Allowed Values: DUNS_NUMBER, BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, BIRTH_CITY, DOCUMENT_NUMBER, AU_ID_NUMBER, AU_ID_TYPE, CA_LEGAL_TYPE, FI_BUSINESS_NUMBER, FI_ID_NUMBER, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
java.lang.String value
Type: String
Default: None
Constraints: Maximum 2048 characters.
Parent:
ExtraParams
Required: Yes
Constraints:
Length: 0 - 2048
java.lang.String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
java.lang.String domainName
Type: String
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> nameservers
Type: String
java.lang.Boolean autoRenew
Type: Boolean
ContactDetail adminContact
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode,
PhoneNumber, Email, Fax,
ExtraParams
ContactDetail registrantContact
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode,
PhoneNumber, Email, Fax,
ExtraParams
ContactDetail techContact
Type: Complex
Children: FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode,
PhoneNumber, Email, Fax,
ExtraParams
java.lang.Boolean adminPrivacy
true, WHOIS
("who is") queries will return contact information for our registrar
partner, Gandi, instead of the contact information that you enter.
Type: Boolean
java.lang.Boolean registrantPrivacy
true, WHOIS
("who is") queries will return contact information for our registrar
partner, Gandi, instead of the contact information that you enter.
Type: Boolean
java.lang.Boolean techPrivacy
true, WHOIS
("who is") queries will return contact information for our registrar
partner, Gandi, instead of the contact information that you enter.
Type: Boolean
java.lang.String registrarName
"GANDI SAS". Type: String
java.lang.String whoIsServer
Type: String
java.lang.String registrarUrl
Type: String
java.lang.String abuseContactEmail
Type: String
Constraints:
Length: 0 - 254
java.lang.String abuseContactPhone
Type: String
Constraints:
Length: 0 - 30
java.lang.String registryDomainId
java.util.Date creationDate
java.util.Date updatedDate
java.util.Date expirationDate
java.lang.String reseller
"Amazon" as the reseller.
Type: String
java.lang.String dnsSec
com.amazonaws.internal.ListWithAutoConstructFlag<T> statusList
ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes.
For a current list of domain name status
codes and an explanation of what each code means, go to the ICANN website and search for
epp status codes. (Search on the ICANN website; web
searches sometimes return an old version of the document.)
Type: Array of String
java.lang.String operationId
Type: String
Constraints:
Length: 0 - 255
java.lang.String status
Type: String
Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, ERROR, SUCCESSFUL, FAILED
java.lang.String message
Type: String
java.lang.String domainName
Type: String
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
java.lang.String type
Type: String
Constraints:
Allowed Values: REGISTER_DOMAIN, DELETE_DOMAIN, TRANSFER_IN_DOMAIN, UPDATE_DOMAIN_CONTACT, UPDATE_NAMESERVER, CHANGE_PRIVACY_PROTECTION, DOMAIN_LOCK
java.util.Date submittedDate
java.lang.String marker
MaxItems, you can use Marker to return
additional domains. Get the value of NextPageMarker from
the previous response, and submit another request that includes the
value of NextPageMarker in the Marker
element. Type: String
Default: None
Constraints: The marker must match the value specified in the previous request.
Required: No
Constraints:
Length: 0 - 4096
java.lang.Integer maxItems
Type: Integer
Default: 20
Constraints: A numeral between 1 and 100.
Required: No
Constraints:
Range: 0 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> domains
Type: Complex type containing a list of domain summaries.
Children: AutoRenew,
DomainName, Expiry,
TransferLock
java.lang.String nextPageMarker
MaxItems
in the request, submit another request and include the value of
NextPageMarker in the value of Marker.
Type: String
Parent: Operations
Constraints:
Length: 0 - 4096
java.lang.String marker
MaxItems, you can use
Marker to return additional operations. Get the value of
NextPageMarker from the previous response, and submit
another request that includes the value of NextPageMarker
in the Marker element. Type: String
Default: None
Required: No
Constraints:
Length: 0 - 4096
java.lang.Integer maxItems
Type: Integer
Default: 20
Constraints: A value between 1 and 100.
Required: No
Constraints:
Range: 0 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> operations
Type: Complex type containing a list of operation summaries
Children: OperationId,
Status, SubmittedDate, Type
java.lang.String nextPageMarker
MaxItems in the request, submit another request and
include the value of NextPageMarker in the value of
Marker. Type: String
Parent:
Operations
Constraints:
Length: 0 - 4096
java.lang.String name
Type: String
Constraint: Maximum 255 characterss
Parent:
Nameservers
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> glueIps
Type: List of IP addresses.
Constraints: The list can contain only one IPv4 and one IPv6 address.
Parent:
Nameservers
java.lang.String operationId
Type: String
Constraints:
Length: 0 - 255
java.lang.String status
Type: String
Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, ERROR, SUCCESSFUL, FAILED
java.lang.String type
Type: String
Valid values:
REGISTER_DOMAIN | DELETE_DOMAIN |
TRANSFER_IN_DOMAIN | UPDATE_DOMAIN_CONTACT |
UPDATE_NAMESERVER |
CHANGE_PRIVACY_PROTECTION | DOMAIN_LOCK
Constraints:
Allowed Values: REGISTER_DOMAIN, DELETE_DOMAIN, TRANSFER_IN_DOMAIN, UPDATE_DOMAIN_CONTACT, UPDATE_NAMESERVER, CHANGE_PRIVACY_PROTECTION, DOMAIN_LOCK
java.util.Date submittedDate
java.lang.String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
java.lang.String idnLangCode
Constraints:
Length: 0 - 3
java.lang.Integer durationInYears
Type: Integer
Default: 1
Valid values: Integer from 1 to 10
Required: Yes
Constraints:
Range: 1 - 10
java.lang.Boolean autoRenew
true) or not (false). Autorenewal only
takes effect after the account is charged. Type: Boolean
Valid
values: true | false
Default:
true
Required: No
ContactDetail adminContact
Type: Complex
Children:
FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode,
PhoneNumber, Email, Fax,
ExtraParams
Required: Yes
ContactDetail registrantContact
Type: Complex
Children:
FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode,
PhoneNumber, Email, Fax,
ExtraParams
Required: Yes
ContactDetail techContact
Type: Complex
Children:
FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode,
PhoneNumber, Email, Fax,
ExtraParams
Required: Yes
java.lang.Boolean privacyProtectAdminContact
Type: Boolean
Default:
true
Valid values: true |
false
Required: No
java.lang.Boolean privacyProtectRegistrantContact
Type: Boolean
Default:
true
Valid values: true |
false
Required: No
java.lang.Boolean privacyProtectTechContact
Type: Boolean
Default:
true
Valid values: true |
false
Required: No
java.lang.String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
java.lang.String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
java.lang.String idnLangCode
Constraints:
Length: 0 - 3
java.lang.Integer durationInYears
Type: Integer
Default: 1
Valid values: Integer from 1 to 10
Required: Yes
Constraints:
Range: 1 - 10
com.amazonaws.internal.ListWithAutoConstructFlag<T> nameservers
Type: Complex
Children: GlueIps, Name
java.lang.String authCode
Type: String
Required: Yes
Constraints:
Length: 0 - 1024
java.lang.Boolean autoRenew
Type: Boolean
Valid values: true |
false
Default: true
Required: No
ContactDetail adminContact
Type: Complex
Children:
FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode,
PhoneNumber, Email, Fax,
ExtraParams
Required: Yes
ContactDetail registrantContact
Type: Complex
Children:
FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode,
PhoneNumber, Email, Fax,
ExtraParams
Required: Yes
ContactDetail techContact
Type: Complex
Children:
FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode,
PhoneNumber, Email, Fax,
ExtraParams
Required: Yes
java.lang.Boolean privacyProtectAdminContact
Type: Boolean
Default:
true
Valid values: true |
false
Required: No
java.lang.Boolean privacyProtectRegistrantContact
Type: Boolean
Default:
true
Valid values: true |
false
Required: No
java.lang.Boolean privacyProtectTechContact
Type: Boolean
Default:
true
Valid values: true |
false
Required: No
java.lang.String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
java.lang.Boolean adminPrivacy
Type: Boolean
Default: None
Valid
values: true | false
Required: No
java.lang.Boolean registrantPrivacy
Type: Boolean
Default: None
Valid
values: true | false
Required: No
java.lang.Boolean techPrivacy
Type: Boolean
Default: None
Valid
values: true | false
Required: No
java.lang.String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
ContactDetail adminContact
Type: Complex
Children:
FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode,
PhoneNumber, Email, Fax,
ExtraParams
Required: Yes
ContactDetail registrantContact
Type: Complex
Children:
FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode,
PhoneNumber, Email, Fax,
ExtraParams
Required: Yes
ContactDetail techContact
Type: Complex
Children:
FirstName, MiddleName,
LastName, ContactType,
OrganizationName, AddressLine1,
AddressLine2, City, State,
CountryCode, ZipCode,
PhoneNumber, Email, Fax,
ExtraParams
Required: Yes
java.lang.String domainName
Type: String
Default: None
Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
Required: Yes
Constraints:
Length: 0 - 255
Pattern: [a-zA-Z0-9_\-.]*
com.amazonaws.internal.ListWithAutoConstructFlag<T> nameservers
Type: Complex
Children: Name, GlueIps
Required: Yes
java.util.HashSet<E> grants
Owner owner
java.lang.String extendedRequestId
java.util.Map<K,V> additionalDetails
java.lang.String errorResponseXml
PauseStatus status
java.lang.String assumedRoleId
Constraints:
Length: 2 - 96
Pattern: [\w+=,.@:-]*
java.lang.String arn
Constraints:
Length: 20 - 2048
java.lang.String roleArn
Constraints:
Length: 20 - 2048
java.lang.String roleSessionName
AssumedRoleUser.
Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*
java.lang.String policy
The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole in Using Temporary Security Credentials.
Constraints:
Length: 1 - 2048
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.Integer durationSeconds
Constraints:
Range: 900 - 3600
java.lang.String externalId
Constraints:
Length: 2 - 96
Pattern: [\w+=,.@:-]*
java.lang.String serialNumber
AssumeRole call. Specify this
value if the trust policy of the role being assumed includes a
condition that requires MFA authentication. The value is either the
serial number for a hardware device (such as
GAHT12345678) or an Amazon Resource Name (ARN) for a
virtual device (such as
arn:aws:iam::123456789012:mfa/user).
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
java.lang.String tokenCode
TokenCode value is missing or expired, the
AssumeRole call returns an "access denied" error.
Constraints:
Length: 6 - 6
Pattern: [\d]*
Credentials credentials
AssumedRoleUser assumedRoleUser
RoleSessionName that
you specified when you called AssumeRole.java.lang.Integer packedPolicySize
Constraints:
Range: 0 -
java.lang.String roleArn
Constraints:
Length: 20 - 2048
java.lang.String principalArn
Constraints:
Length: 20 - 2048
java.lang.String sAMLAssertion
For more information, see Configuring a Relying Party and Adding Claims in the Using IAM guide.
Constraints:
Length: 4 - 50000
java.lang.String policy
The policy parameter is optional. If
you pass a policy, the temporary security credentials that are
returned by the operation have the permissions that are allowed by
both the access policy of the role that is being assumed,
and the policy that you pass. This gives you a way to
further restrict the permissions for the resulting temporary security
credentials. You cannot use the passed policy to grant permissions
that are in excess of those allowed by the access policy of the role
that is being assumed. For more information, see Permissions
for AssumeRoleWithSAML in Using Temporary Security
Credentials.
Constraints:
Length: 1 - 2048
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.Integer durationSeconds
NotOnOrAfter value.
The actual expiration time is whichever value is shorter.
Constraints:
Range: 900 - 129600
Credentials credentials
AssumedRoleUser assumedRoleUser
java.lang.Integer packedPolicySize
Constraints:
Range: 0 -
java.lang.String subject
java.lang.String subjectType
java.lang.String issuer
java.lang.String audience
java.lang.String nameQualifier
java.lang.String roleArn
Constraints:
Length: 20 - 2048
java.lang.String roleSessionName
AssumedRoleUser response element.
Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*
java.lang.String webIdentityToken
AssumeRoleWithWebIdentity call.
Constraints:
Length: 4 - 2048
java.lang.String providerId
accounts.google.com. Do not include URL schemes and port
numbers. Currently, www.amazon.com and
graph.facebook.com are supported.
Constraints:
Length: 4 - 2048
java.lang.String policy
The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRoleWithWebIdentity in Using Temporary Security Credentials.
Constraints:
Length: 1 - 2048
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.Integer durationSeconds
Constraints:
Range: 900 - 129600
Credentials credentials
java.lang.String subjectFromWebIdentityToken
WebIdentityToken
that was submitted with the AssumeRoleWithWebIdentity
call. The identifier is typically unique to the user and the
application that acquired the WebIdentityToken (pairwise
identifier). If an OpenID Connect ID token was submitted in the
WebIdentityToken, this value is returned by the identity
provider as the token's sub (Subject) claim.
Constraints:
Length: 6 - 255
AssumedRoleUser assumedRoleUser
RoleSessionName that
you specified when you called AssumeRole.java.lang.Integer packedPolicySize
Constraints:
Range: 0 -
java.lang.String provider
iss
field. For OAuth 2.0 Access Tokens, this contains the value of the
ProviderId parameter that was passed in the
AssumeRoleWithWebIdentity request.java.lang.String audience
java.lang.String accessKeyId
Constraints:
Length: 16 - 32
Pattern: [\w]*
java.lang.String secretAccessKey
java.lang.String sessionToken
java.util.Date expiration
java.lang.String federatedUserId
Constraints:
Length: 2 - 96
Pattern: [\w+=,.@\:-]*
java.lang.String arn
Constraints:
Length: 20 - 2048
java.lang.String name
Bob). For
example, you can reference the federated user name in a resource-based
policy, such as in an Amazon S3 bucket policy.
Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*
java.lang.String policy
GetFederationToken call and evaluated along with the
policy or policies that are attached to the IAM user whose credentials
are used to call GetFederationToken. The passed policy is
used to scope down the permissions that are available to the IAM user,
by allowing only a subset of the permissions that are granted to the
IAM user. The passed policy cannot grant more permissions than those
granted to the IAM user. The final permissions for the federated user
are the most restrictive set based on the intersection of the passed
policy and the IAM user policy. If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.
For more information about how permissions work, see Permissions for GetFederationToken in Using Temporary Security Credentials.
Constraints:
Length: 1 - 2048
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
java.lang.Integer durationSeconds
Constraints:
Range: 900 - 129600
Credentials credentials
FederatedUser federatedUser
arn:aws:sts::123456789012:federated-user/Bob or
123456789012:Bob). You can use the federated user's ARN
in your resource-based policies, such as an Amazon S3 bucket policy.java.lang.Integer packedPolicySize
Constraints:
Range: 0 -
java.lang.Integer durationSeconds
Constraints:
Range: 900 - 129600
java.lang.String serialNumber
GetSessionToken call.
Specify this value if the IAM user has a policy that requires MFA
authentication. The value is either the serial number for a hardware
device (such as GAHT12345678) or an Amazon Resource Name
(ARN) for a virtual device (such as
arn:aws:iam::123456789012:mfa/user). You can find the
device for an IAM user by going to the AWS Management Console and
viewing the user's security credentials.
Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*
java.lang.String tokenCode
Constraints:
Length: 6 - 6
Pattern: [\d]*
Credentials credentials
java.lang.String domainName
java.lang.String itemName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
UpdateCondition expected
java.lang.Integer itemCount
java.lang.Long itemNamesSizeBytes
java.lang.Integer attributeNameCount
java.lang.Long attributeNamesSizeBytes
java.lang.Integer attributeValueCount
java.lang.Long attributeValuesSizeBytes
java.lang.Integer timestamp
java.lang.String domainName
java.lang.String itemName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeNames
java.lang.Boolean consistentRead
true, any data previously
written to SimpleDB will be returned. Otherwise, results will be
consistent eventually, and the client may not see data that was
written immediately before your read.java.lang.String domainName
java.lang.String itemName
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes
UpdateCondition expected
java.lang.String name
java.lang.String value
java.lang.Boolean replace
false.java.lang.String selectExpression
java.lang.String nextToken
ItemNames.java.lang.Boolean consistentRead
true, any data previously
written to SimpleDB will be returned. Otherwise, results will be
consistent eventually, and the client may not see data that was
written immediately before your read.com.amazonaws.internal.ListWithAutoConstructFlag<T> items
java.lang.String nextToken
MaxNumberOfItems were matched, the response size exceeded
1 megabyte, or the execution time exceeded 5 seconds.java.lang.String name
java.lang.String value
Exists parameter is equal to true.java.lang.Boolean exists
true if the attribute must exist for
the update condition to be satisfied. Specify false if
the attribute should not exist in order for the update condition to be
satisfied.Content text
Content html
com.amazonaws.internal.ListWithAutoConstructFlag<T> toAddresses
com.amazonaws.internal.ListWithAutoConstructFlag<T> ccAddresses
com.amazonaws.internal.ListWithAutoConstructFlag<T> bccAddresses
java.lang.Double max24HourSend
java.lang.Double maxSendRate
java.lang.Double sentLast24Hours
java.lang.Boolean dkimEnabled
java.lang.String dkimVerificationStatus
Constraints:
Allowed Values: Pending, Success, Failed, TemporaryFailure, NotStarted
com.amazonaws.internal.ListWithAutoConstructFlag<T> dkimTokens
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
java.lang.String bounceTopic
java.lang.String complaintTopic
java.lang.String deliveryTopic
java.lang.Boolean forwardingEnabled
true indicates that Amazon SES
will forward bounce and complaint notifications as email, while
false indicates that bounce and complaint notifications
will be published only to the specified bounce and complaint Amazon
SNS topics.java.lang.String verificationStatus
Constraints:
Allowed Values: Pending, Success, Failed, TemporaryFailure, NotStarted
java.lang.String verificationToken
java.lang.String identityType
Constraints:
Allowed Values: EmailAddress, Domain
java.lang.String nextToken
java.lang.Integer maxItems
java.nio.ByteBuffer data
The To:, CC:, and BCC: headers in the raw message can contain a group list.
For more information, go to the Amazon SES Developer Guide.
java.util.Date timestamp
java.lang.Long deliveryAttempts
java.lang.Long bounces
java.lang.Long complaints
java.lang.Long rejects
java.lang.String source
By default, the string must be 7-bit
ASCII. If the text must contain any other characters, then you must
use MIME encoded-word syntax (RFC 2047) instead of a literal string.
MIME encoded-word syntax uses the following form:
=?charset?encoding?encoded-text?=. For more information,
see RFC 2047.
Destination destination
Message message
com.amazonaws.internal.ListWithAutoConstructFlag<T> replyToAddresses
java.lang.String returnPath
ReturnPath parameter.java.lang.String source
By default, the string must be 7-bit
ASCII. If the text must contain any other characters, then you must
use MIME encoded-word syntax (RFC 2047) instead of a literal string.
MIME encoded-word syntax uses the following form:
=?charset?encoding?encoded-text?=. For more information,
see RFC 2047.
Source parameter and have
feedback forwarding enabled, then bounces and complaints will be sent
to this email address. This takes precedence over any
Return-Path header that you might include in the raw text of
the message.
com.amazonaws.internal.ListWithAutoConstructFlag<T> destinations
RawMessage rawMessage
java.lang.String identity
user@example.com,
example.com.java.lang.Boolean forwardingEnabled
true specifies that Amazon SES
will forward bounce and complaint notifications as email, in addition
to any Amazon SNS topic publishing otherwise specified.
false specifies that Amazon SES will publish bounce and
complaint notifications only through Amazon SNS. This value can only
be set to false when Amazon SNS topics are set for both
Bounce and Complaint notification types.java.lang.String identity
user@example.com, example.com.java.lang.String notificationType
Constraints:
Allowed Values: Bounce, Complaint, Delivery
java.lang.String snsTopic
SnsTopic is cleared and publishing is disabled.com.amazonaws.internal.ListWithAutoConstructFlag<T> dkimTokens
Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign emails originating from that domain.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
ActivityType activityType
java.lang.String activityId
ActivityTaskTimeoutType timeoutType
java.lang.String details
WorkflowExecution workflowExecution
WorkflowType workflowType
ScheduleActivityTaskFailedCause failureCause
SignalExternalWorkflowExecutionFailedCause failureCause
WorkflowExecution signaledExecution
StartChildWorkflowExecutionFailedCause failureCause
StartTimerFailedCause failureCause
java.lang.String taskToken
Constraints:
Length: 1 - 1024
java.lang.String activityId
Constraints:
Length: 1 - 256
java.lang.Long startedEventId
ActivityTaskStarted event recorded in the
history.WorkflowExecution workflowExecution
ActivityType activityType
java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.Long scheduledEventId
ActivityTaskScheduled event that was
recorded when this activity task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.java.lang.Long startedEventId
ActivityTaskStarted event recorded when
this activity task was started. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.java.lang.Long latestCancelRequestedEventId
ActivityTaskCancelRequested event recorded for this
activity task. This information can be useful for diagnosing problems
by tracing back the chain of events leading up to this event.java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
RequestCancelActivityTask decision for this cancellation
request. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.java.lang.String activityId
Constraints:
Length: 1 - 256
java.lang.String result
Constraints:
Length: 0 - 32768
java.lang.Long scheduledEventId
ActivityTaskScheduled event that was
recorded when this activity task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.java.lang.Long startedEventId
ActivityTaskStarted event recorded when
this activity task was started. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.java.lang.String reason
Constraints:
Length: 0 - 256
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.Long scheduledEventId
ActivityTaskScheduled event that was
recorded when this activity task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.java.lang.Long startedEventId
ActivityTaskStarted event recorded when
this activity task was started. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.ActivityType activityType
java.lang.String activityId
Constraints:
Length: 1 - 256
java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String scheduleToStartTimeout
Constraints:
Length: 0 - 8
java.lang.String scheduleToCloseTimeout
Constraints:
Length: 0 - 8
java.lang.String startToCloseTimeout
Constraints:
Length: 0 - 8
TaskList taskList
java.lang.String taskPriority
Valid values are
integers that range from Java's Integer.MIN_VALUE
(-2147483648) to Integer.MAX_VALUE (2147483647). Higher
numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision that resulted in the scheduling of this activity task.
This information can be useful for diagnosing problems by tracing back
the chain of events leading up to this event.java.lang.String heartbeatTimeout
Constraints:
Length: 0 - 8
java.lang.String identity
Constraints:
Length: 0 - 256
java.lang.Long scheduledEventId
ActivityTaskScheduled event that was
recorded when this activity task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.java.lang.String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE, SCHEDULE_TO_START, SCHEDULE_TO_CLOSE, HEARTBEAT
java.lang.Long scheduledEventId
ActivityTaskScheduled event that was
recorded when this activity task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.java.lang.Long startedEventId
ActivityTaskStarted event recorded when
this activity task was started. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.java.lang.String details
details parameter for the
last call made by the activity to
RecordActivityTaskHeartbeat.
Constraints:
Length: 0 - 2048
java.lang.String name
Constraints:
Length: 1 - 256
java.lang.String version
Constraints:
Length: 1 - 64
java.lang.String defaultTaskStartToCloseTimeout
ScheduleActivityTask Decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
java.lang.String defaultTaskHeartbeatTimeout
You can specify this value only
when registering an activity type. The registered default value
can be overridden when you schedule a task through the
ScheduleActivityTask Decision. If the activity
worker subsequently attempts to record a heartbeat or returns a
result, the activity worker receives an UnknownResource
fault. In this case, Amazon SWF no longer considers the activity task
to be valid; the activity worker should clean up the activity task.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList defaultTaskList
ScheduleActivityTask Decision. You can override
the default registered task list when scheduling a task through the
ScheduleActivityTask Decision.java.lang.String defaultTaskPriority
Valid values are integers that range from Java's
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
java.lang.String defaultTaskScheduleToStartTimeout
ScheduleActivityTask
Decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
java.lang.String defaultTaskScheduleToCloseTimeout
ScheduleActivityTask Decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
ActivityTypeInfo typeInfo
The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.
ActivityTypeConfiguration configuration
ActivityType activityType
java.lang.String status
Constraints:
Allowed Values: REGISTERED, DEPRECATED
java.lang.String description
Constraints:
Length: 0 - 1024
java.util.Date creationDate
java.util.Date deprecationDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> typeInfos
java.lang.String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
java.lang.String timerId
CancelTimer decision that
failed.
Constraints:
Length: 1 - 256
java.lang.String cause
Constraints:
Allowed Values: TIMER_ID_UNKNOWN, OPERATION_NOT_PERMITTED
java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the CancelTimer
decision to cancel this timer. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.java.lang.String cause
Constraints:
Allowed Values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED
java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
CancelWorkflowExecution decision for this cancellation
request. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.WorkflowExecution workflowExecution
WorkflowType workflowType
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.Long initiatedEventId
StartChildWorkflowExecutionInitiated event
corresponding to the StartChildWorkflowExecution
Decision to start this child workflow execution. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.java.lang.Long startedEventId
ChildWorkflowExecutionStarted event
recorded when this child workflow execution was started. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.WorkflowExecution workflowExecution
WorkflowType workflowType
java.lang.String result
Constraints:
Length: 0 - 32768
java.lang.Long initiatedEventId
StartChildWorkflowExecutionInitiated event
corresponding to the StartChildWorkflowExecution
Decision to start this child workflow execution. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.java.lang.Long startedEventId
ChildWorkflowExecutionStarted event
recorded when this child workflow execution was started. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.WorkflowExecution workflowExecution
WorkflowType workflowType
java.lang.String reason
Constraints:
Length: 0 - 256
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.Long initiatedEventId
StartChildWorkflowExecutionInitiated event
corresponding to the StartChildWorkflowExecution
Decision to start this child workflow execution. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.java.lang.Long startedEventId
ChildWorkflowExecutionStarted event
recorded when this child workflow execution was started. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.WorkflowExecution workflowExecution
WorkflowType workflowType
java.lang.Long initiatedEventId
StartChildWorkflowExecutionInitiated event
corresponding to the StartChildWorkflowExecution
Decision to start this child workflow execution. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.WorkflowExecution workflowExecution
WorkflowType workflowType
java.lang.Long initiatedEventId
StartChildWorkflowExecutionInitiated event
corresponding to the StartChildWorkflowExecution
Decision to start this child workflow execution. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.java.lang.Long startedEventId
ChildWorkflowExecutionStarted event
recorded when this child workflow execution was started. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.WorkflowExecution workflowExecution
WorkflowType workflowType
java.lang.String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE
java.lang.Long initiatedEventId
StartChildWorkflowExecutionInitiated event
corresponding to the StartChildWorkflowExecution
Decision to start this child workflow execution. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.java.lang.Long startedEventId
ChildWorkflowExecutionStarted event
recorded when this child workflow execution was started. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.java.lang.String cause
Constraints:
Allowed Values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED
java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
CompleteWorkflowExecution decision to complete this
execution. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.String executionStartToCloseTimeout
defaultExecutionStartToCloseTimeout
specified when registering the workflow type. The duration is
specified in seconds; an integer greater than or equal to 0. The value
"NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList taskList
java.lang.String taskPriority
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
java.lang.String taskStartToCloseTimeout
defaultTaskStartToCloseTimout specified when registering
the workflow type using RegisterWorkflowType. The duration
is specified in seconds; an integer greater than or equal to 0. The
value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
java.lang.String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
java.lang.String workflowTypeVersion
java.lang.String cause
Constraints:
Allowed Values: UNHANDLED_DECISION, WORKFLOW_TYPE_DEPRECATED, WORKFLOW_TYPE_DOES_NOT_EXIST, DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_LIST_UNDEFINED, DEFAULT_CHILD_POLICY_UNDEFINED, CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED
java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
ContinueAsNewWorkflowExecution decision that started this
execution. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.java.lang.String domain
Constraints:
Length: 1 - 256
ExecutionTimeFilter startTimeFilter
startTimeFilter
and closeTimeFilter are mutually exclusive. You must
specify one of these in a request but not both.ExecutionTimeFilter closeTimeFilter
startTimeFilter
and closeTimeFilter are mutually exclusive. You must
specify one of these in a request but not both.WorkflowExecutionFilter executionFilter
WorkflowId in the filter are counted.
closeStatusFilter, executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.WorkflowTypeFilter typeFilter
closeStatusFilter,
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.TagFilter tagFilter
closeStatusFilter,
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.CloseStatusFilter closeStatusFilter
executionStatus is specified as CLOSED.
closeStatusFilter, executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.java.lang.String domain
Constraints:
Length: 1 - 256
ExecutionTimeFilter startTimeFilter
WorkflowTypeFilter typeFilter
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.TagFilter tagFilter
executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.WorkflowExecutionFilter executionFilter
WorkflowId in the filter are counted.
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.java.lang.String domain
Constraints:
Length: 1 - 256
TaskList taskList
java.lang.String domain
Constraints:
Length: 1 - 256
TaskList taskList
java.lang.String decisionType
Constraints:
Allowed Values: ScheduleActivityTask, RequestCancelActivityTask, CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution, ContinueAsNewWorkflowExecution, RecordMarker, StartTimer, CancelTimer, SignalExternalWorkflowExecution, RequestCancelExternalWorkflowExecution, StartChildWorkflowExecution
ScheduleActivityTaskDecisionAttributes scheduleActivityTaskDecisionAttributes
ScheduleActivityTask decision. It
is not set for other decision types.RequestCancelActivityTaskDecisionAttributes requestCancelActivityTaskDecisionAttributes
RequestCancelActivityTask
decision. It is not set for other decision types.CompleteWorkflowExecutionDecisionAttributes completeWorkflowExecutionDecisionAttributes
CompleteWorkflowExecution
decision. It is not set for other decision types.FailWorkflowExecutionDecisionAttributes failWorkflowExecutionDecisionAttributes
FailWorkflowExecution decision.
It is not set for other decision types.CancelWorkflowExecutionDecisionAttributes cancelWorkflowExecutionDecisionAttributes
CancelWorkflowExecution decision.
It is not set for other decision types.ContinueAsNewWorkflowExecutionDecisionAttributes continueAsNewWorkflowExecutionDecisionAttributes
ContinueAsNewWorkflowExecution
decision. It is not set for other decision types.RecordMarkerDecisionAttributes recordMarkerDecisionAttributes
RecordMarker decision. It is not
set for other decision types.StartTimerDecisionAttributes startTimerDecisionAttributes
StartTimer decision. It is not
set for other decision types.CancelTimerDecisionAttributes cancelTimerDecisionAttributes
CancelTimer decision. It is not
set for other decision types.SignalExternalWorkflowExecutionDecisionAttributes signalExternalWorkflowExecutionDecisionAttributes
SignalExternalWorkflowExecution
decision. It is not set for other decision types.RequestCancelExternalWorkflowExecutionDecisionAttributes requestCancelExternalWorkflowExecutionDecisionAttributes
RequestCancelExternalWorkflowExecution decision. It is
not set for other decision types.StartChildWorkflowExecutionDecisionAttributes startChildWorkflowExecutionDecisionAttributes
StartChildWorkflowExecution
decision. It is not set for other decision types.java.lang.String taskToken
Constraints:
Length: 1 - 1024
java.lang.Long startedEventId
DecisionTaskStarted event recorded in the
history.WorkflowExecution workflowExecution
WorkflowType workflowType
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
java.lang.String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
java.lang.Long previousStartedEventId
java.lang.String executionContext
Constraints:
Length: 0 - 32768
java.lang.Long scheduledEventId
DecisionTaskScheduled event that was
recorded when this decision task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.java.lang.Long startedEventId
DecisionTaskStarted event recorded when
this decision task was started. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.TaskList taskList
java.lang.String taskPriority
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
java.lang.String startToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
java.lang.String identity
Constraints:
Length: 0 - 256
java.lang.Long scheduledEventId
DecisionTaskScheduled event that was
recorded when this decision task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.java.lang.String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE
java.lang.Long scheduledEventId
DecisionTaskScheduled event that was
recorded when this decision task was scheduled. This information can
be useful for diagnosing problems by tracing back the chain of events
leading up to this event.java.lang.Long startedEventId
DecisionTaskStarted event recorded when
this decision task was started. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.java.lang.String domain
Constraints:
Length: 1 - 256
ActivityType activityType
java.lang.String domain
Constraints:
Length: 1 - 256
WorkflowType workflowType
java.lang.String domain
Constraints:
Length: 1 - 256
ActivityType activityType
name and version that were
supplied when the activity was registered.java.lang.String domain
Constraints:
Length: 1 - 256
WorkflowExecution execution
java.lang.String domain
Constraints:
Length: 1 - 256
WorkflowType workflowType
DomainInfo domainInfo
DomainConfiguration configuration
java.lang.String name
Constraints:
Length: 1 - 256
java.lang.String status
Constraints:
Allowed Values: REGISTERED, DEPRECATED
java.lang.String description
Constraints:
Length: 0 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainInfos
java.lang.String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
WorkflowExecution workflowExecution
java.lang.Long initiatedEventId
RequestCancelExternalWorkflowExecutionInitiated event
corresponding to the
RequestCancelExternalWorkflowExecution decision to cancel
this external workflow execution. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.WorkflowExecution workflowExecution
java.lang.Long initiatedEventId
SignalExternalWorkflowExecutionInitiated
event corresponding to the
SignalExternalWorkflowExecution decision to request this
signal. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.java.lang.String cause
Constraints:
Allowed Values: UNHANDLED_DECISION, OPERATION_NOT_PERMITTED
java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
FailWorkflowExecution decision to fail this execution.
This information can be useful for diagnosing problems by tracing back
the chain of events leading up to this event.java.lang.String domain
Constraints:
Length: 1 - 256
WorkflowExecution execution
java.lang.String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
java.lang.Integer maximumPageSize
nextPageToken can be used to obtain futher pages of
results. The default is 100, which is the maximum allowed page size.
You can, however, specify a page size smaller than 100. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Constraints:
Range: 0 - 1000
java.lang.Boolean reverseOrder
true, returns the events in reverse order. By
default the results are returned in ascending order of the
eventTimeStamp of the events.com.amazonaws.internal.ListWithAutoConstructFlag<T> events
java.lang.String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
java.util.Date eventTimestamp
java.lang.String eventType
Constraints:
Allowed Values: WorkflowExecutionStarted, WorkflowExecutionCancelRequested, WorkflowExecutionCompleted, CompleteWorkflowExecutionFailed, WorkflowExecutionFailed, FailWorkflowExecutionFailed, WorkflowExecutionTimedOut, WorkflowExecutionCanceled, CancelWorkflowExecutionFailed, WorkflowExecutionContinuedAsNew, ContinueAsNewWorkflowExecutionFailed, WorkflowExecutionTerminated, DecisionTaskScheduled, DecisionTaskStarted, DecisionTaskCompleted, DecisionTaskTimedOut, ActivityTaskScheduled, ScheduleActivityTaskFailed, ActivityTaskStarted, ActivityTaskCompleted, ActivityTaskFailed, ActivityTaskTimedOut, ActivityTaskCanceled, ActivityTaskCancelRequested, RequestCancelActivityTaskFailed, WorkflowExecutionSignaled, MarkerRecorded, RecordMarkerFailed, TimerStarted, StartTimerFailed, TimerFired, TimerCanceled, CancelTimerFailed, StartChildWorkflowExecutionInitiated, StartChildWorkflowExecutionFailed, ChildWorkflowExecutionStarted, ChildWorkflowExecutionCompleted, ChildWorkflowExecutionFailed, ChildWorkflowExecutionTimedOut, ChildWorkflowExecutionCanceled, ChildWorkflowExecutionTerminated, SignalExternalWorkflowExecutionInitiated, SignalExternalWorkflowExecutionFailed, ExternalWorkflowExecutionSignaled, RequestCancelExternalWorkflowExecutionInitiated, RequestCancelExternalWorkflowExecutionFailed, ExternalWorkflowExecutionCancelRequested
java.lang.Long eventId
WorkflowExecutionStartedEventAttributes workflowExecutionStartedEventAttributes
WorkflowExecutionStarted then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionCompletedEventAttributes workflowExecutionCompletedEventAttributes
WorkflowExecutionCompleted then
this member is set and provides detailed information about the event.
It is not set for other event types.CompleteWorkflowExecutionFailedEventAttributes completeWorkflowExecutionFailedEventAttributes
CompleteWorkflowExecutionFailed
then this member is set and provides detailed information about the
event. It is not set for other event types.WorkflowExecutionFailedEventAttributes workflowExecutionFailedEventAttributes
WorkflowExecutionFailed then this
member is set and provides detailed information about the event. It is
not set for other event types.FailWorkflowExecutionFailedEventAttributes failWorkflowExecutionFailedEventAttributes
FailWorkflowExecutionFailed then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionTimedOutEventAttributes workflowExecutionTimedOutEventAttributes
WorkflowExecutionTimedOut then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionCanceledEventAttributes workflowExecutionCanceledEventAttributes
WorkflowExecutionCanceled then
this member is set and provides detailed information about the event.
It is not set for other event types.CancelWorkflowExecutionFailedEventAttributes cancelWorkflowExecutionFailedEventAttributes
CancelWorkflowExecutionFailed
then this member is set and provides detailed information about the
event. It is not set for other event types.WorkflowExecutionContinuedAsNewEventAttributes workflowExecutionContinuedAsNewEventAttributes
WorkflowExecutionContinuedAsNew
then this member is set and provides detailed information about the
event. It is not set for other event types.ContinueAsNewWorkflowExecutionFailedEventAttributes continueAsNewWorkflowExecutionFailedEventAttributes
ContinueAsNewWorkflowExecutionFailed then this member is
set and provides detailed information about the event. It is not set
for other event types.WorkflowExecutionTerminatedEventAttributes workflowExecutionTerminatedEventAttributes
WorkflowExecutionTerminated then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionCancelRequestedEventAttributes workflowExecutionCancelRequestedEventAttributes
WorkflowExecutionCancelRequested
then this member is set and provides detailed information about the
event. It is not set for other event types.DecisionTaskScheduledEventAttributes decisionTaskScheduledEventAttributes
DecisionTaskScheduled then this
member is set and provides detailed information about the event. It is
not set for other event types.DecisionTaskStartedEventAttributes decisionTaskStartedEventAttributes
DecisionTaskStarted then this
member is set and provides detailed information about the event. It is
not set for other event types.DecisionTaskCompletedEventAttributes decisionTaskCompletedEventAttributes
DecisionTaskCompleted then this
member is set and provides detailed information about the event. It is
not set for other event types.DecisionTaskTimedOutEventAttributes decisionTaskTimedOutEventAttributes
DecisionTaskTimedOut then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskScheduledEventAttributes activityTaskScheduledEventAttributes
ActivityTaskScheduled then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskStartedEventAttributes activityTaskStartedEventAttributes
ActivityTaskStarted then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskCompletedEventAttributes activityTaskCompletedEventAttributes
ActivityTaskCompleted then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskFailedEventAttributes activityTaskFailedEventAttributes
ActivityTaskFailed then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskTimedOutEventAttributes activityTaskTimedOutEventAttributes
ActivityTaskTimedOut then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskCanceledEventAttributes activityTaskCanceledEventAttributes
ActivityTaskCanceled then this
member is set and provides detailed information about the event. It is
not set for other event types.ActivityTaskCancelRequestedEventAttributes activityTaskCancelRequestedEventAttributes
ActivityTaskcancelRequested then
this member is set and provides detailed information about the event.
It is not set for other event types.WorkflowExecutionSignaledEventAttributes workflowExecutionSignaledEventAttributes
WorkflowExecutionSignaled then
this member is set and provides detailed information about the event.
It is not set for other event types.MarkerRecordedEventAttributes markerRecordedEventAttributes
MarkerRecorded then this member
is set and provides detailed information about the event. It is not
set for other event types.RecordMarkerFailedEventAttributes recordMarkerFailedEventAttributes
DecisionTaskFailed then this
member is set and provides detailed information about the event. It is
not set for other event types.TimerStartedEventAttributes timerStartedEventAttributes
TimerStarted then this member is
set and provides detailed information about the event. It is not set
for other event types.TimerFiredEventAttributes timerFiredEventAttributes
TimerFired then this member is
set and provides detailed information about the event. It is not set
for other event types.TimerCanceledEventAttributes timerCanceledEventAttributes
TimerCanceled then this member is
set and provides detailed information about the event. It is not set
for other event types.StartChildWorkflowExecutionInitiatedEventAttributes startChildWorkflowExecutionInitiatedEventAttributes
StartChildWorkflowExecutionInitiated then this member is
set and provides detailed information about the event. It is not set
for other event types.ChildWorkflowExecutionStartedEventAttributes childWorkflowExecutionStartedEventAttributes
ChildWorkflowExecutionStarted
then this member is set and provides detailed information about the
event. It is not set for other event types.ChildWorkflowExecutionCompletedEventAttributes childWorkflowExecutionCompletedEventAttributes
ChildWorkflowExecutionCompleted
then this member is set and provides detailed information about the
event. It is not set for other event types.ChildWorkflowExecutionFailedEventAttributes childWorkflowExecutionFailedEventAttributes
ChildWorkflowExecutionFailed then
this member is set and provides detailed information about the event.
It is not set for other event types.ChildWorkflowExecutionTimedOutEventAttributes childWorkflowExecutionTimedOutEventAttributes
ChildWorkflowExecutionTimedOut
then this member is set and provides detailed information about the
event. It is not set for other event types.ChildWorkflowExecutionCanceledEventAttributes childWorkflowExecutionCanceledEventAttributes
ChildWorkflowExecutionCanceled
then this member is set and provides detailed information about the
event. It is not set for other event types.ChildWorkflowExecutionTerminatedEventAttributes childWorkflowExecutionTerminatedEventAttributes
ChildWorkflowExecutionTerminated
then this member is set and provides detailed information about the
event. It is not set for other event types.SignalExternalWorkflowExecutionInitiatedEventAttributes signalExternalWorkflowExecutionInitiatedEventAttributes
SignalExternalWorkflowExecutionInitiated then this member
is set and provides detailed information about the event. It is not
set for other event types.ExternalWorkflowExecutionSignaledEventAttributes externalWorkflowExecutionSignaledEventAttributes
ExternalWorkflowExecutionSignaled
then this member is set and provides detailed information about the
event. It is not set for other event types.SignalExternalWorkflowExecutionFailedEventAttributes signalExternalWorkflowExecutionFailedEventAttributes
SignalExternalWorkflowExecutionFailed then this member is
set and provides detailed information about the event. It is not set
for other event types.ExternalWorkflowExecutionCancelRequestedEventAttributes externalWorkflowExecutionCancelRequestedEventAttributes
ExternalWorkflowExecutionCancelRequested then this member
is set and provides detailed information about the event. It is not
set for other event types.RequestCancelExternalWorkflowExecutionInitiatedEventAttributes requestCancelExternalWorkflowExecutionInitiatedEventAttributes
RequestCancelExternalWorkflowExecutionInitiated then this
member is set and provides detailed information about the event. It is
not set for other event types.RequestCancelExternalWorkflowExecutionFailedEventAttributes requestCancelExternalWorkflowExecutionFailedEventAttributes
RequestCancelExternalWorkflowExecutionFailed then this
member is set and provides detailed information about the event. It is
not set for other event types.ScheduleActivityTaskFailedEventAttributes scheduleActivityTaskFailedEventAttributes
ScheduleActivityTaskFailed then
this member is set and provides detailed information about the event.
It is not set for other event types.RequestCancelActivityTaskFailedEventAttributes requestCancelActivityTaskFailedEventAttributes
RequestCancelActivityTaskFailed
then this member is set and provides detailed information about the
event. It is not set for other event types.StartTimerFailedEventAttributes startTimerFailedEventAttributes
StartTimerFailed then this member
is set and provides detailed information about the event. It is not
set for other event types.CancelTimerFailedEventAttributes cancelTimerFailedEventAttributes
CancelTimerFailed then this
member is set and provides detailed information about the event. It is
not set for other event types.StartChildWorkflowExecutionFailedEventAttributes startChildWorkflowExecutionFailedEventAttributes
StartChildWorkflowExecutionFailed
then this member is set and provides detailed information about the
event. It is not set for other event types.java.lang.String domain
Constraints:
Length: 1 - 256
java.lang.String name
Constraints:
Length: 1 - 256
java.lang.String registrationStatus
Constraints:
Allowed Values: REGISTERED, DEPRECATED
java.lang.String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
java.lang.Integer maximumPageSize
nextPageToken can be used to obtain futher pages of
results. The default is 100, which is the maximum allowed page size.
You can, however, specify a page size smaller than 100. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Constraints:
Range: 0 - 1000
java.lang.Boolean reverseOrder
true, returns the results in reverse order.
By default, the results are returned in ascending alphabetical order
by name of the activity types.java.lang.String domain
Constraints:
Length: 1 - 256
ExecutionTimeFilter startTimeFilter
startTimeFilter and closeTimeFilter
are mutually exclusive. You must specify one of these in a request but
not both.ExecutionTimeFilter closeTimeFilter
startTimeFilter and closeTimeFilter
are mutually exclusive. You must specify one of these in a request but
not both.WorkflowExecutionFilter executionFilter
closeStatusFilter, executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.CloseStatusFilter closeStatusFilter
closeStatusFilter, executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.WorkflowTypeFilter typeFilter
closeStatusFilter,
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.TagFilter tagFilter
closeStatusFilter, executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.java.lang.String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
java.lang.Integer maximumPageSize
nextPageToken can be used to obtain futher pages of
results. The default is 100, which is the maximum allowed page size.
You can, however, specify a page size smaller than 100. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Constraints:
Range: 0 - 1000
java.lang.Boolean reverseOrder
true, returns the results in reverse order.
By default the results are returned in descending order of the start
or the close time of the executions.java.lang.String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
java.lang.String registrationStatus
Constraints:
Allowed Values: REGISTERED, DEPRECATED
java.lang.Integer maximumPageSize
nextPageToken can be used to obtain futher pages of
results. The default is 100, which is the maximum allowed page size.
You can, however, specify a page size smaller than 100. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Constraints:
Range: 0 - 1000
java.lang.Boolean reverseOrder
true, returns the results in reverse order.
By default, the results are returned in ascending alphabetical order
by name of the domains.java.lang.String domain
Constraints:
Length: 1 - 256
ExecutionTimeFilter startTimeFilter
WorkflowTypeFilter typeFilter
executionFilter, typeFilter
and tagFilter are mutually exclusive. You can specify at
most one of these in a request.TagFilter tagFilter
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.java.lang.String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
java.lang.Integer maximumPageSize
nextPageToken can be used to obtain futher pages of
results. The default is 100, which is the maximum allowed page size.
You can, however, specify a page size smaller than 100. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Constraints:
Range: 0 - 1000
java.lang.Boolean reverseOrder
true, returns the results in reverse order.
By default the results are returned in descending order of the start
time of the executions.WorkflowExecutionFilter executionFilter
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.java.lang.String domain
Constraints:
Length: 1 - 256
java.lang.String name
Constraints:
Length: 1 - 256
java.lang.String registrationStatus
Constraints:
Allowed Values: REGISTERED, DEPRECATED
java.lang.String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
java.lang.Integer maximumPageSize
nextPageToken can be used to obtain futher pages of
results. The default is 100, which is the maximum allowed page size.
You can, however, specify a page size smaller than 100. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Constraints:
Range: 0 - 1000
java.lang.Boolean reverseOrder
true, returns the results in reverse order.
By default the results are returned in ascending alphabetical order of
the name of the workflow types.java.lang.String markerName
Constraints:
Length: 1 - 256
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the RecordMarker
decision that requested this marker. This information can be useful
for diagnosing problems by tracing back the chain of events leading up
to this event.java.lang.String domain
Constraints:
Length: 1 - 256
TaskList taskList
The specified
string must not start or end with whitespace. It must not contain a
: (colon), / (slash), |
(vertical bar), or any control characters ( - | -
Ÿ). Also, it must not contain the literal string "arn".
java.lang.String identity
ActivityTaskStarted event in the workflow history. This
enables diagnostic tracing when problems arise. The form of this
identity is user defined.
Constraints:
Length: 0 - 256
java.lang.String domain
Constraints:
Length: 1 - 256
TaskList taskList
The specified
string must not start or end with whitespace. It must not contain a
: (colon), / (slash), |
(vertical bar), or any control characters ( - | -
Ÿ). Also, it must not contain the literal string "arn".
java.lang.String identity
Constraints:
Length: 0 - 256
java.lang.String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call. nextPageToken
returned by this action cannot be used with
GetWorkflowExecutionHistory to get the next page. You must call
PollForDecisionTask again (with the nextPageToken)
to retrieve the next page of history records. Calling
PollForDecisionTask with a nextPageToken will not
return a new decision task.
Constraints:
Length: 0 - 2048
java.lang.Integer maximumPageSize
nextPageToken can be used to obtain futher pages of
results. The default is 100, which is the maximum allowed page size.
You can, however, specify a page size smaller than 100. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Constraints:
Range: 0 - 1000
java.lang.Boolean reverseOrder
true, returns the events in reverse order. By
default the results are returned in ascending order of the
eventTimestamp of the events.java.lang.String taskToken
taskToken of the ActivityTask. taskToken is generated by the service and should be
treated as an opaque value. If the task is passed to another process,
its taskToken must also be passed. This enables it to
provide its progress and respond with results.
Constraints:
Length: 1 - 1024
java.lang.String details
Constraints:
Length: 0 - 2048
java.lang.String markerName
Constraints:
Length: 1 - 256
java.lang.String cause
Constraints:
Allowed Values: OPERATION_NOT_PERMITTED
java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
RecordMarkerFailed decision for this cancellation
request. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.java.lang.String domain
Constraints:
Length: 1 - 256
java.lang.String name
The specified
string must not start or end with whitespace. It must not contain a
: (colon), / (slash), |
(vertical bar), or any control characters ( - | -
Ÿ). Also, it must not contain the literal string "arn".
Constraints:
Length: 1 - 256
java.lang.String version
The specified string must not start or end with
whitespace. It must not contain a : (colon),
/ (slash), | (vertical bar), or any control
characters ( - | - Ÿ). Also, it must not
contain the literal string "arn".
Constraints:
Length: 1 - 64
java.lang.String description
Constraints:
Length: 0 - 1024
java.lang.String defaultTaskStartToCloseTimeout
ScheduleActivityTask Decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
java.lang.String defaultTaskHeartbeatTimeout
ScheduleActivityTask Decision. If the activity
worker subsequently attempts to record a heartbeat or returns a
result, the activity worker receives an UnknownResource
fault. In this case, Amazon SWF no longer considers the activity task
to be valid; the activity worker should clean up the activity task.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList defaultTaskList
ScheduleActivityTask Decision.java.lang.String defaultTaskPriority
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
java.lang.String defaultTaskScheduleToStartTimeout
ScheduleActivityTask Decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
java.lang.String defaultTaskScheduleToCloseTimeout
ScheduleActivityTask
Decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
java.lang.String name
The specified string must not
start or end with whitespace. It must not contain a :
(colon), / (slash), | (vertical bar), or any
control characters ( - | - Ÿ). Also, it must
not contain the literal string "arn".
Constraints:
Length: 1 - 256
java.lang.String description
Constraints:
Length: 0 - 1024
java.lang.String workflowExecutionRetentionPeriodInDays
If you pass the value
NONE or 0 (zero), then the workflow
execution history will not be retained. As soon as the workflow
execution completes, the execution record and its history are deleted.
The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.
Constraints:
Length: 1 - 8
java.lang.String domain
Constraints:
Length: 1 - 256
java.lang.String name
The specified string must not start
or end with whitespace. It must not contain a : (colon),
/ (slash), | (vertical bar), or any control
characters ( - | - Ÿ). Also, it must not
contain the literal string "arn".
Constraints:
Length: 1 - 256
java.lang.String version
The specified
string must not start or end with whitespace. It must not contain a
: (colon), / (slash), |
(vertical bar), or any control characters ( - | -
Ÿ). Also, it must not contain the literal string "arn".
Constraints:
Length: 1 - 64
java.lang.String description
Constraints:
Length: 0 - 1024
java.lang.String defaultTaskStartToCloseTimeout
StartChildWorkflowExecution Decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
java.lang.String defaultExecutionStartToCloseTimeout
StartChildWorkflowExecution Decision. The
duration is specified in seconds; an integer greater than or equal to
0. Unlike some of the other timeout parameters in Amazon SWF, you
cannot specify a value of "NONE" for
defaultExecutionStartToCloseTimeout; there is a one-year
max limit on the time that a workflow execution can run. Exceeding
this limit will always cause the workflow execution to time out.
Constraints:
Length: 0 - 8
TaskList defaultTaskList
StartChildWorkflowExecution Decision.java.lang.String defaultTaskPriority
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
java.lang.String defaultChildPolicy
StartChildWorkflowExecution Decision. The supported child policies are:
WorkflowExecutionCancelRequested event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
java.lang.String activityId
RequestCancelActivityTask
decision that failed.
Constraints:
Length: 1 - 256
java.lang.String cause
Constraints:
Allowed Values: ACTIVITY_ID_UNKNOWN, OPERATION_NOT_PERMITTED
java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
RequestCancelActivityTask decision for this cancellation
request. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.java.lang.String workflowId
workflowId of the external workflow
execution to cancel.
Constraints:
Length: 1 - 256
java.lang.String runId
runId of the external workflow execution to cancel.
Constraints:
Length: 0 - 64
java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String workflowId
workflowId of the external workflow to which the
cancel request was to be delivered.
Constraints:
Length: 1 - 256
java.lang.String runId
runId of the external workflow execution.
Constraints:
Length: 0 - 64
java.lang.String cause
Constraints:
Allowed Values: UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION, REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED
java.lang.Long initiatedEventId
RequestCancelExternalWorkflowExecutionInitiated event
corresponding to the
RequestCancelExternalWorkflowExecution decision to cancel
this external workflow execution. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
RequestCancelExternalWorkflowExecution decision for this
cancellation request. This information can be useful for diagnosing
problems by tracing back the chain of events leading up to this event.java.lang.String control
java.lang.String workflowId
workflowId of the external workflow execution to be
canceled.
Constraints:
Length: 1 - 256
java.lang.String runId
runId of the external workflow execution to be
canceled.
Constraints:
Length: 0 - 64
java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
RequestCancelExternalWorkflowExecution decision for this
cancellation request. This information can be useful for diagnosing
problems by tracing back the chain of events leading up to this event.java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String domain
Constraints:
Length: 1 - 256
java.lang.String workflowId
Constraints:
Length: 1 - 256
java.lang.String runId
Constraints:
Length: 0 - 64
java.lang.String taskToken
taskToken of the ActivityTask.
taskToken is generated by the service and
should be treated as an opaque value. If the task is passed to another
process, its taskToken must also be passed. This enables
it to provide its progress and respond with results.
Constraints:
Length: 1 - 1024
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.String taskToken
taskToken of the ActivityTask. taskToken is generated by the service and should be
treated as an opaque value. If the task is passed to another process,
its taskToken must also be passed. This enables it to
provide its progress and respond with results.
Constraints:
Length: 1 - 1024
java.lang.String result
Constraints:
Length: 0 - 32768
java.lang.String taskToken
taskToken of the ActivityTask. taskToken is generated by the service and should be
treated as an opaque value. If the task is passed to another process,
its taskToken must also be passed. This enables it to
provide its progress and respond with results.
Constraints:
Length: 1 - 1024
java.lang.String reason
Constraints:
Length: 0 - 256
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.String taskToken
taskToken from the DecisionTask.
taskToken is generated by the service and
should be treated as an opaque value. If the task is passed to another
process, its taskToken must also be passed. This enables
it to provide its progress and respond with results.
Constraints:
Length: 1 - 1024
com.amazonaws.internal.ListWithAutoConstructFlag<T> decisions
java.lang.String executionContext
Constraints:
Length: 0 - 32768
ActivityType activityType
java.lang.String activityId
activityId of the activity task.
The specified string must not start or end with whitespace. It must
not contain a : (colon), / (slash),
| (vertical bar), or any control characters
( - | - Ÿ). Also, it must not contain the
literal string "arn".
Constraints:
Length: 1 - 256
java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.String scheduleToCloseTimeout
The duration is
specified in seconds; an integer greater than or equal to 0. The value
"NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList taskList
defaultTaskList
registered with the activity type will be used. The specified string must not start or end
with whitespace. It must not contain a : (colon),
/ (slash), | (vertical bar), or any control
characters ( - | - Ÿ). Also, it must not
contain the literal string "arn".
java.lang.String taskPriority
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
java.lang.String scheduleToStartTimeout
The duration is specified in
seconds; an integer greater than or equal to 0. The value "NONE" can
be used to specify unlimited duration.
Constraints:
Length: 0 - 8
java.lang.String startToCloseTimeout
The duration is specified in seconds;
an integer greater than or equal to 0. The value "NONE" can be used to
specify unlimited duration.
Constraints:
Length: 0 - 8
java.lang.String heartbeatTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
ActivityType activityType
ScheduleActivityTask
decision that failed.java.lang.String activityId
ScheduleActivityTask
decision that failed.
Constraints:
Length: 1 - 256
java.lang.String cause
Constraints:
Allowed Values: ACTIVITY_TYPE_DEPRECATED, ACTIVITY_TYPE_DOES_NOT_EXIST, ACTIVITY_ID_ALREADY_IN_USE, OPEN_ACTIVITIES_LIMIT_EXCEEDED, ACTIVITY_CREATION_RATE_EXCEEDED, DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_LIST_UNDEFINED, DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED, DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED, OPERATION_NOT_PERMITTED
java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision that resulted in the scheduling of this activity task.
This information can be useful for diagnosing problems by tracing back
the chain of events leading up to this event.java.lang.String workflowId
workflowId of the workflow execution
to be signaled.
Constraints:
Length: 1 - 256
java.lang.String runId
runId of the workflow execution to be signaled.
Constraints:
Length: 0 - 64
java.lang.String signalName
Constraints:
Length: 1 - 256
java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String workflowId
workflowId of the external workflow execution that
the signal was being delivered to.
Constraints:
Length: 1 - 256
java.lang.String runId
runId of the external workflow execution that the
signal was being delivered to.
Constraints:
Length: 0 - 64
java.lang.String cause
Constraints:
Allowed Values: UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION, SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED
java.lang.Long initiatedEventId
SignalExternalWorkflowExecutionInitiated
event corresponding to the
SignalExternalWorkflowExecution decision to request this
signal. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
SignalExternalWorkflowExecution decision for this signal.
This information can be useful for diagnosing problems by tracing back
the chain of events leading up to this event.java.lang.String control
java.lang.String workflowId
workflowId of the external workflow execution.
Constraints:
Length: 1 - 256
java.lang.String runId
runId of the external workflow execution to send the
signal to.
Constraints:
Length: 0 - 64
java.lang.String signalName
Constraints:
Length: 1 - 256
java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
SignalExternalWorkflowExecution decision for this signal.
This information can be useful for diagnosing problems by tracing back
the chain of events leading up to this event.java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String domain
Constraints:
Length: 1 - 256
java.lang.String workflowId
Constraints:
Length: 1 - 256
java.lang.String runId
Constraints:
Length: 0 - 64
java.lang.String signalName
Constraints:
Length: 1 - 256
java.lang.String input
WorkflowExecutionSignaled event in
the target workflow execution's history.
Constraints:
Length: 0 - 32768
WorkflowType workflowType
java.lang.String workflowId
workflowId of the workflow
execution. The specified string must not start or end with
whitespace. It must not contain a : (colon),
/ (slash), | (vertical bar), or any control
characters ( - | - Ÿ). Also, it must not
contain the literal string "arn".
Constraints:
Length: 1 - 256
java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.String executionStartToCloseTimeout
The duration is specified in seconds; an integer
greater than or equal to 0. The value "NONE" can be used to specify
unlimited duration.
Constraints:
Length: 0 - 8
TaskList taskList
The specified string must not start or end with
whitespace. It must not contain a : (colon),
/ (slash), | (vertical bar), or any control
characters ( - | - Ÿ). Also, it must not
contain the literal string "arn".
java.lang.String taskPriority
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
java.lang.String taskStartToCloseTimeout
defaultTaskStartToCloseTimout specified when registering
the workflow type using RegisterWorkflowType. The duration
is specified in seconds; an integer greater than or equal to 0. The
value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
java.lang.String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
WorkflowType workflowType
StartChildWorkflowExecution Decision that failed.java.lang.String cause
Constraints:
Allowed Values: WORKFLOW_TYPE_DOES_NOT_EXIST, WORKFLOW_TYPE_DEPRECATED, OPEN_CHILDREN_LIMIT_EXCEEDED, OPEN_WORKFLOWS_LIMIT_EXCEEDED, CHILD_CREATION_RATE_EXCEEDED, WORKFLOW_ALREADY_RUNNING, DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_TASK_LIST_UNDEFINED, DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED, DEFAULT_CHILD_POLICY_UNDEFINED, OPERATION_NOT_PERMITTED
java.lang.String workflowId
workflowId of the child workflow execution.
Constraints:
Length: 1 - 256
java.lang.Long initiatedEventId
StartChildWorkflowExecutionInitiated event
corresponding to the StartChildWorkflowExecution
Decision to start this child workflow execution. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
StartChildWorkflowExecution Decision to request
this child workflow execution. This information can be useful for
diagnosing problems by tracing back the cause of events.java.lang.String control
java.lang.String workflowId
workflowId of the child workflow execution.
Constraints:
Length: 1 - 256
WorkflowType workflowType
java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.String executionStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList taskList
java.lang.String taskPriority
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
StartChildWorkflowExecution Decision to request
this child workflow execution. This information can be useful for
diagnosing problems by tracing back the cause of events.java.lang.String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
java.lang.String taskStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
java.lang.String timerId
The specified string
must not start or end with whitespace. It must not contain a
: (colon), / (slash), |
(vertical bar), or any control characters ( - | -
Ÿ). Also, it must not contain the literal string "arn".
Constraints:
Length: 1 - 256
java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String startToFireTimeout
The duration is specified in seconds; an integer greater than or equal to 0.
Constraints:
Length: 1 - 8
java.lang.String timerId
StartTimer decision that
failed.
Constraints:
Length: 1 - 256
java.lang.String cause
Constraints:
Allowed Values: TIMER_ID_ALREADY_IN_USE, OPEN_TIMERS_LIMIT_EXCEEDED, TIMER_CREATION_RATE_EXCEEDED, OPERATION_NOT_PERMITTED
java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the StartTimer
decision for this activity task. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.java.lang.String domain
Constraints:
Length: 1 - 256
java.lang.String workflowId
workflowId at
the same time. The specified string must not start or end with
whitespace. It must not contain a : (colon),
/ (slash), | (vertical bar), or any control
characters ( - | - Ÿ). Also, it must not
contain the literal string "arn".
Constraints:
Length: 1 - 256
WorkflowType workflowType
TaskList taskList
defaultTaskList
specified when registering the workflow type. The specified string must not start
or end with whitespace. It must not contain a : (colon),
/ (slash), | (vertical bar), or any control
characters ( - | - Ÿ). Also, it must not
contain the literal string "arn".
java.lang.String taskPriority
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
java.lang.String input
input is made available to the new workflow execution in
the WorkflowExecutionStarted history event.
Constraints:
Length: 0 - 32768
java.lang.String executionStartToCloseTimeout
The duration is specified in seconds; an integer
greater than or equal to 0. Exceeding this limit will cause the
workflow execution to time out. Unlike some of the other timeout
parameters in Amazon SWF, you cannot specify a value of "NONE" for
this timeout; there is a one-year max limit on the time that a
workflow execution can run.
Constraints:
Length: 0 - 8
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
java.lang.String taskStartToCloseTimeout
defaultTaskStartToCloseTimout specified when registering
the workflow type using RegisterWorkflowType. The duration
is specified in seconds; an integer greater than or equal to 0. The
value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
java.lang.String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
java.lang.String domain
Constraints:
Length: 1 - 256
java.lang.String workflowId
Constraints:
Length: 1 - 256
java.lang.String runId
Constraints:
Length: 0 - 64
java.lang.String reason
Constraints:
Length: 0 - 256
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
java.lang.String timerId
Constraints:
Length: 1 - 256
java.lang.Long startedEventId
TimerStarted event that was recorded when
this timer was started. This information can be useful for diagnosing
problems by tracing back the chain of events leading up to this event.java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the CancelTimer
decision to cancel this timer. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.java.lang.String timerId
Constraints:
Length: 1 - 256
java.lang.Long startedEventId
TimerStarted event that was recorded when
this timer was started. This information can be useful for diagnosing
problems by tracing back the chain of events leading up to this event.java.lang.String timerId
Constraints:
Length: 1 - 256
java.lang.String control
Constraints:
Length: 0 - 32768
java.lang.String startToFireTimeout
The duration is specified in seconds; an integer greater than or equal to 0.
Constraints:
Length: 1 - 8
java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the StartTimer
decision for this activity task. This information can be useful for
diagnosing problems by tracing back the chain of events leading up to
this event.java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
CancelWorkflowExecution decision for this cancellation
request. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.WorkflowExecution externalWorkflowExecution
java.lang.Long externalInitiatedEventId
RequestCancelExternalWorkflowExecutionInitiated event
corresponding to the
RequestCancelExternalWorkflowExecution decision to cancel
this workflow execution.The source event with this Id can be found in
the history of the source workflow execution. This information can be
useful for diagnosing problems by tracing back the chain of events
leading up to this event.java.lang.String cause
Constraints:
Allowed Values: CHILD_POLICY_APPLIED
java.lang.String result
Constraints:
Length: 0 - 32768
java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
CompleteWorkflowExecution decision to complete this
execution. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.java.lang.String taskStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 1 - 8
java.lang.String executionStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 1 - 8
TaskList taskList
java.lang.String taskPriority
Integer.MIN_VALUE (-2147483648) to
Integer.MAX_VALUE (2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
java.lang.String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
ContinueAsNewWorkflowExecution decision that started this
execution. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.java.lang.String newExecutionRunId
runId of the new workflow execution.
Constraints:
Length: 1 - 64
java.lang.String executionStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList taskList
java.lang.String taskPriority
java.lang.String taskStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
java.lang.String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
WorkflowType workflowType
WorkflowExecutionInfo executionInfo
WorkflowExecutionConfiguration executionConfiguration
WorkflowExecutionOpenCounts openCounts
java.util.Date latestActivityTaskTimestamp
java.lang.String latestExecutionContext
Constraints:
Length: 0 - 32768
java.lang.String reason
Constraints:
Length: 0 - 256
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.Long decisionTaskCompletedEventId
DecisionTaskCompleted event corresponding
to the decision task that resulted in the
FailWorkflowExecution decision to fail this execution.
This information can be useful for diagnosing problems by tracing back
the chain of events leading up to this event.WorkflowExecution execution
WorkflowType workflowType
java.util.Date startTimestamp
java.util.Date closeTimestamp
java.lang.String executionStatus
Constraints:
Allowed Values: OPEN, CLOSED
java.lang.String closeStatus
COMPLETED: the execution
was successfully completed.CANCELED: the
execution was canceled.Cancellation allows the implementation to
gracefully clean up before the execution is closed.TERMINATED: the execution was force terminated.FAILED: the execution failed to complete.TIMED_OUT: the execution did not complete in the
alloted time and was automatically timed out.CONTINUED_AS_NEW: the execution is logically
continued. This means the current execution was completed and a new
execution was started to carry on the workflow.
Constraints:
Allowed Values: COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT
WorkflowExecution parent
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
java.lang.Boolean cancelRequested
com.amazonaws.internal.ListWithAutoConstructFlag<T> executionInfos
java.lang.String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
java.lang.Integer openActivityTasks
Constraints:
Range: 0 -
java.lang.Integer openDecisionTasks
Constraints:
Range: 0 - 1
java.lang.Integer openTimers
Constraints:
Range: 0 -
java.lang.Integer openChildWorkflowExecutions
Constraints:
Range: 0 -
java.lang.String signalName
Constraints:
Length: 1 - 256
java.lang.String input
Constraints:
Length: 0 - 32768
WorkflowExecution externalWorkflowExecution
java.lang.Long externalInitiatedEventId
SignalExternalWorkflowExecutionInitiated
event corresponding to the SignalExternalWorkflow
decision to signal this workflow execution.The source event with this
Id can be found in the history of the source workflow execution. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event. This field is set only if
the signal was initiated by another workflow execution.java.lang.String input
Constraints:
Length: 0 - 32768
java.lang.String executionStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
java.lang.String taskStartToCloseTimeout
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
java.lang.String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
TaskList taskList
WorkflowType workflowType
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
Constraints:
Length: 0 - 5
java.lang.String taskPriority
java.lang.String continuedExecutionRunId
ContinueAsNewWorkflowExecution decision, then it contains
the runId of the previous workflow execution that was
closed and continued as this execution.
Constraints:
Length: 0 - 64
WorkflowExecution parentWorkflowExecution
java.lang.Long parentInitiatedEventId
StartChildWorkflowExecutionInitiated event
corresponding to the StartChildWorkflowExecution
Decision to start this workflow execution. The source event
with this Id can be found in the history of the source workflow
execution. This information can be useful for diagnosing problems by
tracing back the chain of events leading up to this event.java.lang.String reason
Constraints:
Length: 0 - 256
java.lang.String details
Constraints:
Length: 0 - 32768
java.lang.String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
java.lang.String cause
Constraints:
Allowed Values: CHILD_POLICY_APPLIED, EVENT_LIMIT_EXCEEDED, OPERATOR_INITIATED
java.lang.String timeoutType
Constraints:
Allowed Values: START_TO_CLOSE
java.lang.String childPolicy
The supported child policies are:
WorkflowExecutionCancelRequested event in its history. It
is up to the decider to take appropriate actions when it receives an
execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
java.lang.String name
Constraints:
Length: 1 - 256
java.lang.String version
Constraints:
Length: 1 - 64
java.lang.String defaultTaskStartToCloseTimeout
StartChildWorkflowExecution Decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
java.lang.String defaultExecutionStartToCloseTimeout
StartChildWorkflowExecution Decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
TaskList defaultTaskList
StartChildWorkflowExecution Decision.java.lang.String defaultTaskPriority
StartChildWorkflowExecution decision. Valid values are
integers that range from Java's Integer.MIN_VALUE
(-2147483648) to Integer.MAX_VALUE (2147483647). Higher
numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
java.lang.String defaultChildPolicy
StartChildWorkflowExecution Decision. The supported child policies are:
WorkflowExecutionCancelRequested event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
WorkflowTypeInfo typeInfo
The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.
WorkflowTypeConfiguration configuration
WorkflowType workflowType
java.lang.String status
Constraints:
Allowed Values: REGISTERED, DEPRECATED
java.lang.String description
Constraints:
Length: 0 - 1024
java.util.Date creationDate
java.util.Date deprecationDate
com.amazonaws.internal.ListWithAutoConstructFlag<T> typeInfos
java.lang.String nextPageToken
NextPageToken was returned by a previous call, there
are more results available. To retrieve the next page of results, make
the call again using the returned token in nextPageToken.
Keep all other arguments unchanged. The configured
maximumPageSize determines how many results can be
returned in a single call.
Constraints:
Length: 0 - 2048
java.lang.String topicArn
java.lang.String label
com.amazonaws.internal.ListWithAutoConstructFlag<T> aWSAccountIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> actionNames
Valid values: any Amazon SNS action name.
java.lang.String topicArn
java.lang.String token
Subscribe action.java.lang.String authenticateOnUnsubscribe
true and the request has an
AWS signature, then only the topic owner and the subscription owner
can unsubscribe the endpoint. The unsubscribe action requires AWS
authentication.java.lang.String name
java.lang.String platform
java.util.Map<K,V> attributes
java.lang.String platformApplicationArn
java.lang.String token
java.lang.String customUserData
java.util.Map<K,V> attributes
java.lang.String topicArn
java.util.Map<K,V> attributes
CustomUserData
-- arbitrary user data to associate with the endpoint. Amazon SNS does
not use this data. The data must be in UTF-8 format and less than
2KB.Enabled -- flag that enables/disables
delivery to the endpoint. Amazon SNS will set this to false when a
notification service indicates to Amazon SNS that the endpoint is
invalid. Users can set it back to true, typically after updating
Token.Token -- device token, also referred to
as a registration id, for an app and mobile device. This is returned
from the notification service when an app and mobile device are
registered with the notification service.java.util.Map<K,V> attributes
EventEndpointCreated -- Topic ARN to which
EndpointCreated event notifications should be sent.EventEndpointDeleted -- Topic ARN to which
EndpointDeleted event notifications should be sent.EventEndpointUpdated -- Topic ARN to which
EndpointUpdate event notifications should be sent.EventDeliveryFailure -- Topic ARN to which
DeliveryFailure event notifications should be sent upon Direct Publish
delivery failure (permanent) to one of the application's
endpoints.java.util.Map<K,V> attributes
SubscriptionArn -- the
subscription's ARNTopicArn -- the topic ARN
that the subscription is associated withOwner
-- the AWS account ID of the subscription's ownerConfirmationWasAuthenticated -- true if the
subscription confirmation request was authenticatedDeliveryPolicy -- the JSON serialization of the
subscription's delivery policyEffectiveDeliveryPolicy -- the JSON serialization of
the effective delivery policy that takes into account the topic
delivery policy and account system defaultsjava.util.Map<K,V> attributes
TopicArn -- the topic's ARNOwner -- the AWS account ID of the topic's ownerPolicy -- the JSON serialization of the topic's
access control policyDisplayName -- the
human-readable name used in the "From" field for notifications to
email and email-json endpointsSubscriptionsPending -- the number of subscriptions
pending confirmation on this topicSubscriptionsConfirmed -- the number of confirmed
subscriptions on this topicSubscriptionsDeleted
-- the number of deleted subscriptions on this topicDeliveryPolicy -- the JSON serialization of the
topic's delivery policyEffectiveDeliveryPolicy
-- the JSON serialization of the effective delivery policy that takes
into account system defaultsjava.lang.String platformApplicationArn
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> endpoints
java.lang.String nextToken
com.amazonaws.internal.ListWithAutoConstructFlag<T> platformApplications
java.lang.String nextToken
java.lang.String dataType
java.lang.String stringValue
java.nio.ByteBuffer binaryValue
java.lang.String topicArn
java.lang.String targetArn
java.lang.String message
If you want to send the same message to all transport protocols, include the text of the message as a String value.
If you want to send different messages
for each transport protocol, set the value of the
MessageStructure parameter to json and use a
JSON object for the Message parameter. See the Examples
section for the format of the JSON object.
Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters).
JSON-specific constraints:
Publish call to return an error (no partial
delivery).java.lang.String subject
Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
java.lang.String messageStructure
MessageStructure to json if you want to
send a different message for each protocol. For example, using one
publish action, you can send a short message to your SMS subscribers
and a longer message to your email subscribers. If you set
MessageStructure to json, the value of the
Message parameter must: You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").
For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.
Valid value:
json
java.util.Map<K,V> messageAttributes
java.lang.String endpointArn
java.util.Map<K,V> attributes
CustomUserData -- arbitrary user data
to associate with the endpoint. Amazon SNS does not use this data. The
data must be in UTF-8 format and less than 2KB.Enabled -- flag that enables/disables delivery to the
endpoint. Amazon SNS will set this to false when a notification
service indicates to Amazon SNS that the endpoint is invalid. Users
can set it back to true, typically after updating Token.Token -- device token, also referred to as a
registration id, for an app and mobile device. This is returned from
the notification service when an app and mobile device are registered
with the notification service.java.lang.String platformApplicationArn
java.util.Map<K,V> attributes
PlatformCredential -- The
credential received from the notification service. For
APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM,
PlatformCredential is "API key". For ADM, PlatformCredential is
"client secret".PlatformPrincipal -- The
principal received from the notification service. For
APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM,
PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is
"client id".EventEndpointCreated -- Topic ARN
to which EndpointCreated event notifications should be sent.EventEndpointDeleted -- Topic ARN to which
EndpointDeleted event notifications should be sent.EventEndpointUpdated -- Topic ARN to which
EndpointUpdate event notifications should be sent.EventDeliveryFailure -- Topic ARN to which
DeliveryFailure event notifications should be sent upon Direct Publish
delivery failure (permanent) to one of the application's
endpoints.java.lang.String subscriptionArn
java.lang.String attributeName
Valid values:
DeliveryPolicy | RawMessageDelivery
java.lang.String attributeValue
java.lang.String topicArn
java.lang.String attributeName
Valid values: Policy |
DisplayName | DeliveryPolicy
java.lang.String attributeValue
java.lang.String topicArn
java.lang.String protocol
http -- delivery of JSON-encoded message via HTTP
POSThttps -- delivery of JSON-encoded message
via HTTPS POSTemail -- delivery of message via
SMTPemail-json -- delivery of JSON-encoded
message via SMTPsms -- delivery of message via
SMSsqs -- delivery of JSON-encoded message to
an Amazon SQS queueapplication -- delivery of
JSON-encoded message to an EndpointArn for a mobile app and
device.java.lang.String endpoint
http protocol, the endpoint is
an URL beginning with "http://"https
protocol, the endpoint is a URL beginning with "https://"email protocol, the endpoint is an email addressemail-json protocol, the endpoint is an email
addresssms protocol, the endpoint is a
phone number of an SMS-enabled devicesqs protocol, the endpoint is the ARN of an Amazon SQS
queueapplication protocol, the endpoint
is the EndpointArn of a mobile app and device.java.lang.String subscriptionArn
java.lang.String owner
java.lang.String protocol
java.lang.String endpoint
java.lang.String topicArn
java.lang.String queueUrl
java.lang.String label
AliceSendMessage). Constraints: Maximum 80 characters;
alphanumeric characters, hyphens (-), and underscores (_) are allowed.com.amazonaws.internal.ListWithAutoConstructFlag<T> aWSAccountIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> actions
* | SendMessage | ReceiveMessage |
DeleteMessage | ChangeMessageVisibility | GetQueueAttributes |
GetQueueUrl. For more information about these actions, see Understanding
Permissions in the Amazon SQS Developer Guide.
Specifying SendMessage, DeleteMessage, or
ChangeMessageVisibility for the ActionName.n
also grants permissions for the corresponding batch versions of those
actions: SendMessageBatch,
DeleteMessageBatch, and
ChangeMessageVisibilityBatch.
java.lang.String id
java.lang.Boolean senderFault
java.lang.String code
java.lang.String message
java.lang.String id
Ids of a batch
request need to be unique within the request.java.lang.String receiptHandle
java.lang.Integer visibilityTimeout
com.amazonaws.internal.ListWithAutoConstructFlag<T> successful
com.amazonaws.internal.ListWithAutoConstructFlag<T> failed
java.lang.String queueUrl
java.lang.String receiptHandle
java.lang.Integer visibilityTimeout
java.lang.String queueName
java.util.Map<K,V> attributes
The following
lists the names, descriptions, and values of the special request
parameters the CreateQueue action uses:
DelaySeconds - The time in seconds that the delivery
of all messages in the queue will be delayed. An integer from 0 to 900
(15 minutes). The default for this attribute is 0 (zero).MaximumMessageSize - The limit of how many bytes a
message can contain before Amazon SQS rejects it. An integer from 1024
bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this
attribute is 262144 (256 KiB).MessageRetentionPeriod - The number of seconds Amazon
SQS retains a message. Integer representing seconds, from 60 (1
minute) to 1209600 (14 days). The default for this attribute is 345600
(4 days).Policy - The queue's policy. A valid
AWS policy. For more information about policy structure, see Overview
of AWS IAM Policies in the Amazon IAM User Guide.ReceiveMessageWaitTimeSeconds - The time for which a
ReceiveMessage call will wait for a message to arrive. An
integer from 0 to 20 (seconds). The default for this attribute is 0.
VisibilityTimeout - The visibility timeout for
the queue. An integer from 0 to 43200 (12 hours). The default for this
attribute is 30. For more information about visibility timeout, see Visibility
Timeout in the Amazon SQS Developer Guide.com.amazonaws.internal.ListWithAutoConstructFlag<T> successful
com.amazonaws.internal.ListWithAutoConstructFlag<T> failed
java.lang.String queueName
java.lang.String queueOwnerAWSAccountId
java.lang.String messageId
java.lang.String receiptHandle
java.lang.String mD5OfBody
java.lang.String body
java.util.Map<K,V> attributes
SenderId, SentTimestamp,
ApproximateReceiveCount, and/or
ApproximateFirstReceiveTimestamp.
SentTimestamp and
ApproximateFirstReceiveTimestamp are each returned as an
integer representing the epoch time in
milliseconds.java.lang.String mD5OfMessageAttributes
java.util.Map<K,V> messageAttributes
java.lang.String stringValue
java.nio.ByteBuffer binaryValue
com.amazonaws.internal.ListWithAutoConstructFlag<T> stringListValues
com.amazonaws.internal.ListWithAutoConstructFlag<T> binaryListValues
java.lang.String dataType
java.lang.String queueUrl
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeNames
The following lists the names and descriptions of the attributes that can be returned:
All - returns all
values.ApproximateFirstReceiveTimestamp -
returns the time when the message was first received from the queue
(epoch time in milliseconds).ApproximateReceiveCount - returns the number of times
a message has been received from the queue but not deleted.SenderId - returns the AWS account number (or the IP
address, if anonymous access is allowed) of the sender.SentTimestamp - returns the time when the message was
sent to the queue (epoch time in milliseconds).com.amazonaws.internal.ListWithAutoConstructFlag<T> messageAttributeNames
When using ReceiveMessage, you can send a
list of attribute names to receive, or you can return all of the
attributes by specifying "All" or ".*" in your request. You can also
use "foo.*" to return all message attributes starting with the "foo"
prefix.
java.lang.Integer maxNumberOfMessages
All of the messages are not necessarily returned.
java.lang.Integer visibilityTimeout
ReceiveMessage request.java.lang.Integer waitTimeSeconds
java.lang.String queueUrl
java.lang.String label
java.lang.String queueUrl
com.amazonaws.internal.ListWithAutoConstructFlag<T> entries
java.lang.String id
Ids of a batch
request need to be unique within the request.java.lang.String messageBody
java.lang.Integer delaySeconds
java.util.Map<K,V> messageAttributes
com.amazonaws.internal.ListWithAutoConstructFlag<T> successful
com.amazonaws.internal.ListWithAutoConstructFlag<T> failed
java.lang.String id
java.lang.String messageId
java.lang.String mD5OfMessageBody
java.lang.String mD5OfMessageAttributes
java.lang.String queueUrl
java.lang.String messageBody
java.lang.Integer delaySeconds
DelaySeconds value
become available for processing after the delay time is finished. If
you don't specify a value, the default value for the queue applies.java.util.Map<K,V> messageAttributes
java.lang.String mD5OfMessageBody
java.lang.String mD5OfMessageAttributes
java.lang.String messageId
java.lang.String queueUrl
java.util.Map<K,V> attributes
The following lists the names,
descriptions, and values of the special request parameters the
SetQueueAttributes action uses:
DelaySeconds - The time in seconds that the delivery
of all messages in the queue will be delayed. An integer from 0 to 900
(15 minutes). The default for this attribute is 0 (zero).MaximumMessageSize - The limit of how many bytes a
message can contain before Amazon SQS rejects it. An integer from 1024
bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this
attribute is 262144 (256 KiB).MessageRetentionPeriod - The number of seconds Amazon
SQS retains a message. Integer representing seconds, from 60 (1
minute) to 1209600 (14 days). The default for this attribute is 345600
(4 days).Policy - The queue's policy. A valid
AWS policy. For more information about policy structure, see Overview
of AWS IAM Policies in the Amazon IAM User Guide.ReceiveMessageWaitTimeSeconds - The time for which a
ReceiveMessage call will wait for a message to arrive. An integer from
0 to 20 (seconds). The default for this attribute is 0. VisibilityTimeout - The visibility timeout for the
queue. An integer from 0 to 43200 (12 hours). The default for this
attribute is 30. For more information about visibility timeout, see
Visibility Timeout in the Amazon SQS Developer Guide.RedrivePolicy - The parameters for dead letter queue
functionality of the source queue. For more information about
RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter
Queues in the Amazon SQS Developer Guide.java.lang.String activationKey
activationKey. It may also include other
activation-related parameters, however, these are merely defaults --
the arguments you pass to the ActivateGateway API call
determine the actual configuration of your gateway.
Constraints:
Length: 1 - 50
java.lang.String gatewayName
Constraints:
Length: 2 - 255
Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$
java.lang.String gatewayTimezone
Constraints:
Length: 3 - 10
java.lang.String gatewayRegion
Host header in the request.
For more information about available regions and endpoints for AWS
Storage Gateway, see Regions
and Endpoints in the Amazon Web Services Glossary.
Valid Values: "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2", "sa-east-1"
Constraints:
Length: 1 - 25
java.lang.String gatewayType
STORED.
Constraints:
Length: 2 - 20
java.lang.String tapeDriveType
Valid Values: "IBM-ULT3580-TD5"
Constraints:
Length: 2 - 50
java.lang.String mediumChangerType
Valid Values: "STK-L700", "AWS-Gateway-VTL"
Constraints:
Length: 2 - 50
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskIds
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskIds
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskIds
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String volumeARN
java.lang.String volumeId
java.lang.String volumeType
java.lang.String volumeStatus
java.lang.Long volumeSizeInBytes
java.lang.Double volumeProgress
java.lang.String sourceSnapshotId
VolumeiSCSIAttributes volumeiSCSIAttributes
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String tapeARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String tapeARN
Constraints:
Length: 50 - 500
java.lang.String targetARN
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
Constraints:
Length: 50 - 800
java.lang.String secretToAuthenticateInitiator
Constraints:
Length: 12 - 16
java.lang.String initiatorName
Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+
java.lang.String secretToAuthenticateTarget
Constraints:
Length: 12 - 16
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.Long volumeSizeInBytes
java.lang.String snapshotId
java.lang.String targetName
java.lang.String networkInterfaceId
java.lang.String clientToken
java.lang.String volumeARN
Constraints:
Length: 50 - 500
java.lang.String snapshotDescription
Constraints:
Length: 1 - 255
java.lang.String volumeARN
Constraints:
Length: 50 - 500
java.lang.String snapshotId
DescribeSnapshots) or creating a volume from a
snapshot (CreateStorediSCSIVolume).
Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String diskId
Constraints:
Length: 1 - 300
java.lang.String snapshotId
Constraints:
Pattern: \Asnap-[0-9a-fA-F]{8}\z
java.lang.Boolean preserveExistingData
Valid Values: true, false
java.lang.String targetName
TargetName as myvolume results in the target ARN
of
arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume.
The target name must be unique across all volumes of a gateway.
Constraints:
Length: 1 - 200
Pattern: ^[-\.;a-z0-9]+$
java.lang.String networkInterfaceId
Valid Values: A valid IP address.
Constraints:
Pattern: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z
java.lang.String volumeARN
Constraints:
Length: 50 - 500
java.lang.Long volumeSizeInBytes
java.lang.String targetARN
Constraints:
Length: 50 - 800
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.Long tapeSizeInBytes
java.lang.String clientToken
ClientToken you specified in the
initial request. ClientToken
prevents creating the tape multiple times.
Constraints:
Length: 5 - 100
java.lang.Integer numTapesToCreate
Constraints:
Range: 1 - 10
java.lang.String tapeBarcodePrefix
Constraints:
Length: 1 - 4
Pattern: ^[A-Z]*$
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String bandwidthType
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String targetARN
Constraints:
Length: 50 - 800
java.lang.String initiatorName
Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String tapeARN
Constraints:
Length: 50 - 500
java.lang.String volumeARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.Long averageUploadRateLimitInBitsPerSec
Constraints:
Range: 51200 -
java.lang.Long averageDownloadRateLimitInBitsPerSec
Constraints:
Range: 102400 -
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskIds
java.lang.Long cacheAllocatedInBytes
java.lang.Double cacheUsedPercentage
java.lang.Double cacheDirtyPercentage
java.lang.Double cacheHitPercentage
java.lang.Double cacheMissPercentage
java.lang.String targetARN
Constraints:
Length: 50 - 800
com.amazonaws.internal.ListWithAutoConstructFlag<T> chapCredentials
InitiatorName: The iSCSI initiator that connects to the target.
SecretToAuthenticateInitiator: The secret key that the initiator (e.g. Windows client) must provide to participate in mutual CHAP with the target.
SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).
TargetARN: The Amazon Resource Name (ARN) of the storage volume.
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayId
Constraints:
Length: 12 - 30
java.lang.String gatewayTimezone
Constraints:
Length: 3 - 10
java.lang.String gatewayState
Constraints:
Length: 2 - 25
com.amazonaws.internal.ListWithAutoConstructFlag<T> gatewayNetworkInterfaces
java.lang.String gatewayType
Constraints:
Length: 2 - 20
java.lang.String nextUpdateAvailabilityDate
Constraints:
Length: 1 - 25
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.Integer hourOfDay
java.lang.Integer minuteOfHour
java.lang.Integer dayOfWeek
java.lang.String timezone
java.lang.String volumeARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeARNs
com.amazonaws.internal.ListWithAutoConstructFlag<T> tapeARNs
java.lang.String marker
Constraints:
Length: 1 - 1000
java.lang.Integer limit
Constraints:
Range: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> tapeArchives
java.lang.String marker
Constraints:
Length: 1 - 1000
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String marker
Constraints:
Length: 1 - 1000
java.lang.Integer limit
Constraints:
Range: 1 -
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> tapeRecoveryPointInfos
java.lang.String marker
Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.
Constraints:
Length: 1 - 1000
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> tapeARNs
java.lang.String marker
DescribeTapes. This marker indicates which page of
results to retrieve. If not specified, the first page of results is retrieved.
Constraints:
Length: 1 - 1000
java.lang.Integer limit
Constraints:
Range: 1 -
com.amazonaws.internal.ListWithAutoConstructFlag<T> tapes
java.lang.String marker
If a response does not contain a marker, then there are no more results to be retrieved.
Constraints:
Length: 1 - 1000
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskIds
java.lang.Long uploadBufferUsedInBytes
java.lang.Long uploadBufferAllocatedInBytes
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> vTLDeviceARNs
java.lang.String marker
Constraints:
Length: 1 - 1000
java.lang.Integer limit
Constraints:
Range: 1 -
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> vTLDevices
java.lang.String marker
Constraints:
Length: 1 - 1000
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> diskIds
java.lang.Long workingStorageUsedInBytes
java.lang.Long workingStorageAllocatedInBytes
java.lang.String targetARN
Constraints:
Length: 50 - 800
java.lang.String networkInterfaceId
Constraints:
Pattern: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z
java.lang.Integer networkInterfacePort
java.lang.Boolean chapEnabled
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String diskId
java.lang.String diskPath
java.lang.String diskNode
java.lang.String diskStatus
java.lang.Long diskSizeInBytes
java.lang.String diskAllocationType
java.lang.String diskAllocationResource
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayType
java.lang.String gatewayOperationalState
java.lang.String marker
Constraints:
Length: 1 - 1000
java.lang.Integer limit
Constraints:
Range: 1 -
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> disks
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeRecoveryPointInfos
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String marker
Constraints:
Length: 1 - 1000
java.lang.Integer limit
Constraints:
Range: 1 -
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String marker
com.amazonaws.internal.ListWithAutoConstructFlag<T> volumeInfos
java.lang.String ipv4Address
java.lang.String macAddress
java.lang.String ipv6Address
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String tapeARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
You retrieve archived virtual tapes to only one gateway and the gateway must be a gateway-VTL.
Constraints:
Length: 50 - 500
java.lang.String tapeARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String volumeARN
java.lang.String volumeId
java.lang.String volumeType
java.lang.String volumeStatus
java.lang.Long volumeSizeInBytes
java.lang.Double volumeProgress
java.lang.String volumeDiskId
java.lang.String sourceSnapshotId
java.lang.Boolean preservedExistingData
VolumeiSCSIAttributes volumeiSCSIAttributes
java.lang.String tapeARN
Constraints:
Length: 50 - 500
java.lang.String tapeBarcode
Constraints:
Length: 8 - 16
Pattern: ^[A-Z0-9]*$
java.lang.Long tapeSizeInBytes
java.lang.String tapeStatus
java.lang.String vTLDevice
Constraints:
Length: 50 - 500
java.lang.Double progress
Range: 0 (not started) to 100 (complete).
java.lang.String tapeARN
Constraints:
Length: 50 - 500
java.lang.String tapeBarcode
Constraints:
Length: 8 - 16
Pattern: ^[A-Z0-9]*$
java.lang.Long tapeSizeInBytes
java.util.Date completionTime
The string format of the completion time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
java.lang.String retrievedTo
The virtual tape is retrieved from the virtual tape shelf (VTS).
Constraints:
Length: 50 - 500
java.lang.String tapeStatus
java.lang.String tapeARN
Constraints:
Length: 50 - 500
java.util.Date tapeRecoveryPointTime
The string format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.
java.lang.Long tapeSizeInBytes
java.lang.String tapeStatus
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.Long averageUploadRateLimitInBitsPerSec
Constraints:
Range: 51200 -
java.lang.Long averageDownloadRateLimitInBitsPerSec
Constraints:
Range: 102400 -
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String targetARN
Constraints:
Length: 50 - 800
java.lang.String secretToAuthenticateInitiator
Constraints:
Length: 12 - 16
java.lang.String initiatorName
Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+
java.lang.String secretToAuthenticateTarget
Constraints:
Length: 12 - 16
java.lang.String targetARN
Constraints:
Length: 50 - 800
java.lang.String initiatorName
Constraints:
Length: 1 - 255
Pattern: [0-9a-z:.-]+
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayName
Constraints:
Length: 2 - 255
Pattern: ^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$
java.lang.String gatewayTimezone
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.Integer hourOfDay
Constraints:
Range: 0 - 23
java.lang.Integer minuteOfHour
Constraints:
Range: 0 - 59
java.lang.Integer dayOfWeek
Constraints:
Range: 0 - 6
java.lang.String gatewayARN
Constraints:
Length: 50 - 500
java.lang.String volumeARN
Constraints:
Length: 50 - 500
java.lang.Integer startAt
Constraints:
Range: 0 - 23
java.lang.Integer recurrenceInHours
Constraints:
Range: 1 - 24
java.lang.String description
Constraints:
Length: 1 - 255
java.lang.String vTLDeviceARN
Constraints:
Length: 50 - 500
java.lang.String deviceType
Valid Values: "STK-L700", "AWS-Gateway-VTL"
Constraints:
Length: 2 - 50
java.lang.String targetARN
Constraints:
Length: 50 - 800
java.lang.String networkInterfaceId
Constraints:
Pattern: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z
java.lang.Integer networkInterfacePort
java.lang.Integer lunNumber
Constraints:
Range: 1 -
java.lang.Boolean chapEnabled
java.lang.String vTLDeviceARN
Constraints:
Length: 50 - 500
java.lang.String vTLDeviceType
java.lang.String vTLDeviceVendor
java.lang.String vTLDeviceProductIdentifier
DeviceiSCSIAttributes deviceiSCSIAttributes
java.lang.String attachmentSetId
AttachmentSetId is
not specified, a new attachment set is created, and the ID of the set
is returned in the response. If an AttachmentSetId is
specified, the attachments are added to the specified set, if it
exists.com.amazonaws.internal.ListWithAutoConstructFlag<T> attachments
java.lang.String attachmentSetId
AttachmentSetId was
not specified, a new attachment set is created, and the ID of the set
is returned in the response. If an AttachmentSetId was
specified, the attachments are added to the specified set, if it
exists.java.lang.String expiryTime
java.lang.String caseId
java.lang.String communicationBody
Constraints:
Length: 1 - 8000
com.amazonaws.internal.ListWithAutoConstructFlag<T> ccEmailAddresses
Constraints:
Length: 0 - 10
java.lang.String attachmentSetId
java.lang.Boolean result
java.lang.String caseId
java.lang.String displayId
java.lang.String subject
java.lang.String status
java.lang.String serviceCode
java.lang.String categoryCode
java.lang.String severityCode
java.lang.String submittedBy
java.lang.String timeCreated
RecentCaseCommunications recentCommunications
nextToken that you can use to retrieve
earlier communications.com.amazonaws.internal.ListWithAutoConstructFlag<T> ccEmailAddresses
java.lang.String language
java.lang.String caseId
java.lang.String body
java.lang.String submittedBy
java.lang.String timeCreated
com.amazonaws.internal.ListWithAutoConstructFlag<T> attachmentSet
java.lang.String subject
java.lang.String serviceCode
Constraints:
Pattern: [0-9a-z\-_]+
java.lang.String severityCode
The availability of severity levels depends on each customer's support subscription. In other words, your subscription may not necessarily require the urgent level of response time.
java.lang.String categoryCode
java.lang.String communicationBody
Constraints:
Length: 1 - 8000
com.amazonaws.internal.ListWithAutoConstructFlag<T> ccEmailAddresses
Constraints:
Length: 0 - 10
java.lang.String language
java.lang.String issueType
java.lang.String attachmentSetId
java.lang.String attachmentId
Attachment attachment
com.amazonaws.internal.ListWithAutoConstructFlag<T> caseIdList
Constraints:
Length: 0 - 100
java.lang.String displayId
java.lang.String afterTime
java.lang.String beforeTime
java.lang.Boolean includeResolvedCases
java.lang.String nextToken
java.lang.Integer maxResults
Constraints:
Range: 10 - 100
java.lang.String language
java.lang.Boolean includeCommunications
java.lang.String caseId
java.lang.String beforeTime
java.lang.String afterTime
java.lang.String nextToken
java.lang.Integer maxResults
Constraints:
Range: 10 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> serviceCodeList
Constraints:
Length: 0 - 100
java.lang.String language
java.lang.String checkId
java.lang.String language
TrustedAdvisorCheckResult result
TrustedAdvisorCheckRefreshStatus status
java.lang.String initialCaseStatus
java.lang.String finalCaseStatus
java.lang.String code
Name element contains the corresponding
friendly name.java.lang.String name
Code element
contains the corresponding code.com.amazonaws.internal.ListWithAutoConstructFlag<T> categories
TrustedAdvisorCostOptimizingSummary costOptimizing
java.lang.String id
java.lang.String name
java.lang.String description
java.lang.String category
com.amazonaws.internal.ListWithAutoConstructFlag<T> metadata
java.lang.String checkId
java.lang.String status
java.lang.Long millisUntilNextRefreshable
java.lang.String checkId
java.lang.String timestamp
java.lang.String status
TrustedAdvisorResourcesSummary resourcesSummary
TrustedAdvisorCategorySpecificSummary categorySpecificSummary
com.amazonaws.internal.ListWithAutoConstructFlag<T> flaggedResources
java.lang.String checkId
java.lang.String timestamp
java.lang.String status
java.lang.Boolean hasFlaggedResources
TrustedAdvisorResourcesSummary resourcesSummary
TrustedAdvisorCategorySpecificSummary categorySpecificSummary
java.lang.Double estimatedMonthlySavings
java.lang.Double estimatedPercentMonthlySavings
java.lang.String status
java.lang.String region
java.lang.String resourceId
java.lang.Boolean isSuppressed
com.amazonaws.internal.ListWithAutoConstructFlag<T> metadata
java.lang.Long resourcesProcessed
java.lang.Long resourcesFlagged
java.lang.Long resourcesIgnored
java.lang.Long resourcesSuppressed
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.